Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Updating access groups by submitting a request to an active instance

Updated on March 15, 2022

Use the prpcServiceUtils command-line tool to update access groups to provide access to a new application version as part of an automated deployment.

You must have a running Pega Platform instance to use the prpcServiceUtils tool.

Follow these steps to update an access group.

  1. Configure the common properties of 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. Optional: Specify the names of the access groups to update.
    If you do not enter a list of access groups, the system updates all access groups that access the application.

    updateAccessGroup.groupList=AccessGroup1, AccessGroup2, AccessGroup3

  3. Specify the application name.
    updateAccessGroup.applicationName=your-application-name
  4. Specify the new application version.
    updateAccessGroup.applicationVersion=X.X.X
  5. Save and close the prpcServiceUtils.properties file.
  6. Run the prpcServiceUtils.bat or prpcServiceUtils.sh script with the updateaccessgroup option, for example:
    prpcServiceUtils.bat updateaccessgroup

    Optional: Pass one or more arguments.

    prpcServiceUtils script argumentAction
    connPropFile Enter the full path to the connection.properties file that includes information for multiple targets.
    poolSizeEnter the thread pool size. Default is 5.
    requestTimeOutSpecify how long the system waits for a response before failing with a time-out error. Default is 300 seconds.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

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