Skip to main content

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

Setting up large message handling for on-premises environments

Updated on July 8, 2022

Pega Platform queue processing can automatically handle messages that exceed the Stream Service default file size threshold. Setting up this feature prevents large messages from breaking when they generate a RecordTooLargeException exception.

Pega Cloud enables the automatic large message exception handling feature by default. To make the feature available for an on-premises or client-managed cloud implementation, you must set up a large message repository and enable the feature by using dynamic system settings.
Note: After completing these steps, it is not necessary to restart the system.
  1. Configure a distributed repository using the Data-Repository Pega Platform class. The repository needs to be shared by all nodes in the cluster. Not all repository types apply. For example, you can use the file system repository type only if it points to a folder on a network drive that all the cluster nodes can access.
  2. In the navigation panel, click RecordsSysAdminDynamic System Settings.
  3. Click the following setting key and enter the name of your new repository:
    • Owning ruleset: Pega-Engine
    • Setting key: queueprocessors/largemessagesnapshot/repository
      Note: The default value is pegacloudfilestorage.
  4. Click the following setting key and enter true:
    • Owning ruleset: Pega-Engine
    • Setting key: queueprocessors/largemessagesnapshot/enabled
      Note: The default value is false.
  5. Click Save.
  6. If necessary, you can change the default base path for the repository using the following setting key. This setting is not available in Dev Studio, however. For more information, see Editing a dynamic system setting.
    • Owning ruleset: Pega-Engine
    • Setting key: queueprocessors/largemessagesnapshot/basepath
    • Value type: string
    • Default value: queueProcessors/largeMessageSnapshots

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. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us