Skip to main content

Updating dynamic system settings by submitting a request to an active instance

Suggest edit Updated on May 11, 2022

You can use the prpcServiceUtils tool to update dynamic system setting values, using a web service to connect to an active instance of Pega Platform.

  1. Create one or more .json files that specify the names and new values of the dynamic system settings.
    • The specified dynamic system setting names must be valid.
    • One or more dynamic system settings can be specified in each file.
    • You must specify the setting value, setting name, and owning ruleset for each dynamic system setting to be updated, in the format:
                  {"dass":[
                  {"pySetting":"DASSValue1","pyPurpose":"DASSName1","pyOwner":"DASS1Owner"}, 
                  {"pySetting":"DASSValue2","pyPurpose":"DASSName2","pyOwner":"DASS2Owner"}]}
    For example:
                {"dass":[
                    {"pySetting":"200",
                      "pyPurpose":"mobile/search/results/maxRecords",
                      "pyOwner":"Pega-UIEngine"}, 
                    {"pySetting":"true",
                      "pyPurpose":"indexing/notify",
                      "pyOwner":"Pega-RULES"}
                ]}
  2. In the prpcServiceUtils.properties file, specify the file names that you created in step 1.

    Property name Value
    updateDASS.filePathOne or more path names that specify the files that specify the dynamic system settings to update, delimited by commas and ending with a semicolon. If the path is a directory, then all .json files in that directory will be processed. For example: C://file1.json,C://dir1//file2.json,C://dir2;

  3. 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

  4. Save and close the prpcServiceUtils.properties file.
  5. To populate the dynamic system settings, run the prpcServiceUtils.bat or prpcServiceUtils.sh script with the updateDASS option, for example: prpcServiceUtils.bat updateDASS
    1. Optional: 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.

    Note: For asynchronous operations, the system response includes the job ID, which you can use to query the job status.
  • Previous topic Editing a dynamic system setting
  • Next topic Updating dynamic system settings by using a direct connection to the database
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