Skip to main content

Retrieving service-enabled job status

Suggest edit Updated on May 11, 2022

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 Required for Pega Cloud clients?
    pega.rest.server.urlThe URL for the REST service, specified in the following format:

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

    For example: http://myhost:8080/prweb/PRRestService
    Yes
    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.host

    The 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.port

    The port for the REST proxy server.

    Required only when using a proxy for a URL.
    pega.rest.proxy.username

    The operator name on the REST proxy server with import and export access.

    Required only when using a proxy for the URL
    pega.rest.proxy.password

    The password of the REST proxy operator.

    Required only when using a proxy for the URL
    pega.rest.proxy.domain

    The domain of the REST proxy server.

    Required only when using a proxy for the URL
    pega.rest.proxy.workstation

    The workstation ID for the REST proxy server.

    Required only when using a proxy for the URL
    pega.rest.response.typeThe REST response type, either xml or json. The default value is json. Rollback, restore point, and update access group operations support only json. Not required
    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 .

    Not required

  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

    Pass 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/logs directory.
    connPropFileThe full path to the serviceConnection.properties file 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, or rollback.

  5. 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
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us