Service-enabled system management command-line tool (prpcServiceUtils)

Service-enabled system management allows asynchronous workflows and faster operations for remote system management on multiple targets. You do not need a direct connection to the database to use the service-enabled system management tool.

Use an active instance of the Pega Platform with a command-line script to configure a REST service to perform the following system management actions:

• Import and export applications, products, or rulesets.
• Update application groups
• Create and manage restore points and roll back to a specific restore point.
• Expose a top-level single value property as a database column, and have the system populate the newly exposed column automatically.

Properties files and command-line arguments

Configure the prpcServiceUtils.bat or prpcServiceUtils.sh script actions in the prpcServiceUtils.properties file. Use a connection.properties file to specify multiple target systems.

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.

Job status

All import, export, expose, and hotfix operations, and all asynchronous rollback operations return a JobID. Use that JobID to check the status of the operation.

Log files

The log files include information about whether a job was successful and include detailed information about job errors and warnings. By default, the log files are stored in the client file system temp directory:

• For synchronous operations, the log file includes the job status. The log file is saved in the logs directory located at:
  temp_dir/utils_dir/logs/export_timestamp/system_name/archive log>
• For asynchronous operations, the log file includes the job ID. The log file is saved in the logs directory located at:
  temp_dir/utils_dir/logs/export_timestamp/system_name_Job_ID/archive log>

For all operations except restore points and roll back, you can use the artifactDir parameter to save a log file to a different directory.

All operations except roll back automatically generate log files. To generate log files for rollback actions, see Rolling back to a restore point.

Open topic with navigation