Retrieving service-enabled job status
Import, export, expose, and hotfix operations, and all asynchronous rollback operations, return a JobID. After you run an asynchronous service-enabled job, retrieve the job status to determine whether the job was successful.
- Configure the common properties in 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.
- Configure the status properties:
Property name Value getstatus.jobID
The job ID for an asynchronous process. getstatus.operationName
The operation name associated with the job ID: import
,export
,expose
,hotfix
, orrollback
. - Save and close the
prpcServiceUtils.properties
file. - Run the
prpcServiceUtils.bat
orprpcServiceUtils.sh
script, for example:prpcServiceUtils.bat getStatus
Pass one or more arguments.
prpcServiceUtils script argument Value artifactsDir
The full path to the output file location, for those functions that generate output. The default is the /scripts/utils/logs
directory.connPropFile
The full path to the serviceConnection.properties
file that includes information for multiple targets.poolSize
The thread pool size. The default is 5. requestTimeOut
The number of seconds the system waits for a response before failing with a time-out error. The default is 300 seconds. jobIdFile
The path to the job IDs file that is generated by the asynchronous operation. propFile
The property file name, to override the default prpcServiceUtils.properties file. operationName
Specify the operation that generated the job ID for getStatus: import
,export
,expose
,hotfix
, orrollback
. - When the system returns the job status, review the message to determine if the job was successful.
Previous topic Service-enabled system management log files Next topic Using scripting with direct connection to the database and the prpcUtils tool