Skip to main content

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

Configuring external temporary storage options for attachments in offline mode

Updated on February 23, 2022

Take advantage of your external storage solutions, such as Amazon S3 or Microsoft Azure, by using these solutions to store temporary files that are sent from your offline-enabled mobile app.

By default, Pega Platform stores all attachments that the mobile device sends to the server in the local data storage.

Before you begin: Ensure that you meet the following conditions for using an external storage service:
  • Obtain access to an Amazon S3 bucket or Microsoft Azure container.
  • Obtain an Amazon Web Services access key or an Microsoft Azure user name and a corresponding password.
  • Choose a root path for your repository.
Note: If you run an on-premises Pega Platform environment with a Postgres database, consider using an external storage to decrease the load on the memory of the Pega Platform server.
In a standard offline workflow, users process cases and can add attachments to these cases. Your app records all actions that users perform while they are offline, in the action queue. When users regain network connectivity, the mobile client sends all actions and attachments that are referenced in the action queue to the default Pega Platform temporary storage (JDBC data source). Apart from replaying all queued actions, the Pega Platform server fetches all attachments from the temporary storage, and then sends them to the target data storage. Afterward, the temporary storage is cleaned.

The default configuration uses the storage/class/uploads:/type dynamic system setting with the value of datastore. You can change the default configuration to use an external storage service as a temporary storage with a set of dynamic system settings.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the SysAdmin category, and then click Dynamic System Settings.
  3. Open and configure the dynamic system settings that are required to use an external temporary storage service.
    Note: If the records list of dynamic system settings in your Pega Platform environment does not have the following entries, create each one. For more information, see Creating a dynamic system setting.
    Dynamic system setting (short description)Owning rulesetValue
    • For Amazon S3: aws-s3
    • For Microsoft Azure: azureblob
    storage/class/uploads:/bucketPega-ProcessCommanderAmazon S3 bucket or Microsoft Azure container location where the files are stored.
    storage/class/uploads:/accesskeyidPega-ProcessCommanderAmazon S3 access key or Microsoft Azure user name.
    storage/class/uploads:/secretaccesskeyPega-ProcessCommanderAmazon S3 or Microsoft Azure password.
    storage/class/uploads:/rootpathPega-ProcessCommanderAmazon S3 or Microsoft Azure root path for the repository.
  4. For each dynamic system setting that you modify, in the upper-right corner of the rule form, click Save.
Result: Your Pega Platform instance now uses an external storage service as a temporary storage for files that are received from mobile devices.
Note: To avoid a loss of data, do not change any of the external storage service components if you suspect that a data transfer might be in progress.
  • Previous topic Disabling server-side postprocessing in offline cases
  • Next topic Adjusting the usability of offline-enabled mobile apps

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