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.propertiesfile.Property name Value Required for Pega Cloud clients? pega.rest.server.urlThe URL for the REST service, specified in the following format:
For example:http://<hostname>:<port>/<context>/PRRestService/http://myhost:8080/prweb/PRRestServiceYes pega.rest.usernameThe operator name on the target system with access to REST services. Yes pega.rest.passwordThe password of the specified operator. Yes pega.rest.proxy.hostThe host name of the REST proxy server. Do not use localhost as the host name.
Required only when using a proxy for a URL. pega.rest.proxy.portThe port for the REST proxy server.
Required only when using a proxy for a URL. pega.rest.proxy.usernameThe operator name on the REST proxy server with import and export access.
Required only when using a proxy for the URL pega.rest.proxy.passwordThe password of the REST proxy operator.
Required only when using a proxy for the URL pega.rest.proxy.domainThe domain of the REST proxy server.
Required only when using a proxy for the URL pega.rest.proxy.workstationThe workstation ID for the REST proxy server.
Required only when using a proxy for the URL pega.rest.response.typeThe REST response type, either xmlorjson. The default value isjson. Rollback, restore point, and update access group operations support onlyjson.Not required user.temp.dirEnter 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 .
Not required - Configure the status properties:
Property name Value getstatus.jobIDThe job ID for an asynchronous process. getstatus.operationNameThe operation name associated with the job ID: import,export,expose,hotfix, orrollback. - Save and close the
prpcServiceUtils.propertiesfile. - Run the
prpcServiceUtils.batorprpcServiceUtils.shscript, for example:prpcServiceUtils.bat getStatusPass one or more arguments.
prpcServiceUtils script argument Value artifactsDirThe full path to the output file location, for those functions that generate output. The default is the /scripts/utils/logsdirectory.connPropFileThe full path to the serviceConnection.propertiesfile that includes information for multiple targets.poolSizeThe thread pool size. The default is 5. requestTimeOutThe number of seconds the system waits for a response before failing with a time-out error. The default is 300 seconds. jobIdFileThe path to the job IDs file that is generated by the asynchronous operation. propFileThe property file name, to override the default prpcServiceUtils.properties file. operationNameSpecify 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