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

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.filePath One 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
    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 .
  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
    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.
    Note: For asynchronous operations, the system response includes the job ID, which you can use to query the job status.