Scanning the system by submitting a request to an active instance
To automate scanning, use the command-line tools. If you have an active instance of Pega Platform, you can scan it by submitting a request to the active instance via a web service.
-
Configure the common properties of the prpcServiceUtils.properties file.
Property name Value pega.rest.server.url
The URL for the REST service, specified in the following format:
For example:http://
<hostname>:
<port>/
<context>/PRRestService/
http://myhost:8080/prweb/PRRestService
pega.rest.username
The operator name on the target system with access to REST services. pega.rest.password
The password of the specified operator. pega.rest.proxy.host
The host name of the REST proxy server. Do not use localhost as the host name.
pega.rest.proxy.port
The port for the REST proxy server.
pega.rest.proxy.username
The operator name on the REST proxy server with import and export access.
pega.rest.proxy.password
The password of the REST proxy operator.
pega.rest.proxy.domain
The domain of the REST proxy server.
pega.rest.proxy.workstation
The workstation ID for the REST proxy server.
pega.rest.response.type
The REST response type, either xml
orjson
. The default value isjson
. Rollback, restore point, and update access group operations support onlyjson
.user.temp.dir
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 scan properties of the prpcServiceUtils.properties file.
Property name Value hotfix.operation
scan
hotfix.catalogPath
The full path to the Catalog.zip file. hotfix.async
true
orfalse
. The default value,true
, executes the hotfix operation asynchronously. The system queues the job and returns a JobID to use to get the job status. A value offalse
executes the operation synchronously. - Save and close the prpcServiceUtils.properties file.
-
Run the prpcServiceUtils.bat or prpcServiceUtils.sh script with the hotfix option, for example:
prpcServiceUtils.bat hotfix
Optional: Pass one or more arguments:
prpcServiceUtils script argument Value connPropFile
The full path to the serviceConnection.properties file that includes information for multiple targets. poolSize
The thread pool size. Default is 5. requestTimeOut
How long the system waits for a response before failing with a time-out error. Default is 300 seconds. jobIdFile
The path to the job IDs file that is generated by the asynchronous operation. propFile
The full path to the properties file, to override the default prpcServiceUtils.properties. - The scan result is the file that you specified in the hotfix.scan.downloadPath property. Send this file to Global Client Support when you request a hotfix package. For more information, see Obtaining hotfix packages.