Retrieving service-enabled job status (prpcServiceUtils)

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.

  1. 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:

    http:// <hostname> : <port> / <context> /PRRestService/

    For example:

    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 Optional: The host name of the REST proxy server. Do not use localhost as the host name.
    pega.rest.proxy.port Optional: The port for the REST proxy server.
    pega.rest.proxy.username Optional: The operator name on the REST proxy server with import and export access.
    pega.rest.proxy.password Optional: The password of the REST proxy operator.
    pega.rest.proxy.domain Optional: The domain of the REST proxy server.
    pega.rest.proxy.workstation Optional: The workstation ID for the REST proxy server.
    pega.rest.response.type The REST response type, either xml or json. The default value is json. Rollback, restore point, and update access group operations support only json.
    user.temp.dir Optional: 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 .

  2. 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, or rollback.
  3. Save and close the prpcServiceUtils.properties file.

  4. Run the prpcServiceUtils.bat or prpcServiceUtils.sh script, for example:

    prpcServiceUtils.bat getStatus

    Optional: 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, or rollback.
  5. When the system returns the job status, review the message to determine if the job was successful.