Retrieving service-enabled job status

After you run an asynchronous service-enabled job, retrieve the job status to determine whether the job was successful.

1. Configure the common properties in the prpcServiceUtils.properties file.

   Property name	Action
   pega.rest.server.url	Enter the URL for the REST service in the following format: http://<hostname>:<port>/context/PRRestService/tenanthash Include the tenant hash only for multitenant systems.
   pega.rest.username	Enter the operator name on the target system with access to REST services.
   pega.rest.password	Enter the password of the specified operator.
   pega.rest.proxy.host	Optional. Enter the host name of the REST proxy server. Do not use localhost as the host name.
   pega.rest.proxy.port	Optional. Enter the port for the REST proxy server.
   pega.rest.proxy.username	Optional. Enter the operator name on the REST proxy server with import and export access.
   pega.rest.proxy.password	Optional. Enter the password of the REST proxy operator.
   pega.rest.proxy.domain	Optional. Enter the domain of the REST proxy server.
   pega.rest.proxy.workstation	Optional. Enter the workstation ID for the REST proxy server.
   pega.rest.response.type	Enter the REST response type, either xml or json. The default value is json.
   user.temp.dir	Optional: Enter the full path to the temporary directory. Leave this blank to use the default temporary directory.

2. Configure the status properties:

   Property name	Action
   getstatus.jobID	For asynchronous mode, enter the job ID.
   getstatus.operationName	Enter the operation name associated with the job ID: import, export, expose, hotfix, or rollback.

3. Save and close prpcServiceUtils.properties.

4. Run the prpcServiceUtils.bat or prpcServiceUtils.sh script. For example:

   prpcServiceUtils.bat getStatus

   You can also pass one or more arguments:

   prpcServiceUtils script argument	Action
   artifactDir	Enter the full path to the output file location. The default is the /scripts/utils/logs directory.
   connPropFile	Enter the full path to the serviceConnection.properties file that includes information for multiple targets.
   poolSize	Enter the thread pool size. Default is 5.
   requestTimeOut	Specify how long the system waits for a response before failing with a timeout error. Default is 300 seconds.
   jobIdFile	Enter the path to the job IDs file that is generated by the asynchronous operation.

   --operationName

   Specify the operation that generated the job ID for getStatus: import, export, or expose.

5. When the system returns the job status, review the message to determine if the job was successful.

Open topic with navigation