Skip to main content

Configuring time-outs for synchronization indicators

Suggest edit
Updated on March 3, 2022

Keep users informed about mobile app synchronization in an efficient way by controlling synchronization indicators. For example, you can determine how long the app displays the Successfully synced message.

Pega Platform provides four types of native indicators:

Offline
The app does not have network access. The Offline indicator disappears only after the app regains network connectivity and starts receiving responses from the server.
Syncing
The app is synchronizing data after reestablishing network connectivity or after a period of low-speed connectivity. You can configure the amount of time that elapses before the app displays the indicator.
Sync failed. Retry?
Data synchronization failed due to an error unrelated to the network. Users can try to synchronize again by tapping the indicator.
Successfully synced
All data and status changes are synchronized with the server. The indicator appears only after the app displays the Syncing indicator. You can configure for how long you want to display the indicator.

Default synchronization indicators in an expense reporting app
Four mobile screens, each with a different synchronization indicator placed horizontally above the bottom navigation menu. "Offline" and "Sync failed" on a red background, "Syncing" and "Successfully synced" on a blue background.

Before you begin: Prepare the framework for your offline-enabled app:Note: After you make changes to your application that affect case management, data management, or the user interface, preview your app on a mobile device to ensure that the app looks and operates as expected. For more information, see Previewing mobile apps.
  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the SysAdmin category, and then click Dynamic System Settings.
  3. Configure one or both of the synchronization indicators:
    ChoicesActions
    Configure the amount of time that elapses before the Syncing indicator appears
    1. In the Setting Purpose column, click offline/ui/deferOngoingSyncNotificationBy.
      The owning ruleset of the offline/ui/deferOngoingSyncNotificationBy dynamic system setting is Pega-UIEngine.
    2. In the Edit Dynamic System settings window, in the Value field, enter the amount of time in milliseconds.
      The default value is 4000.
      For example: If you enter 5000 in the Value field, five seconds elapse before the app displays the Syncing indicator.
      Tip: If you do not want to display the Syncing indicator, enter 100000000 in the Value field.
    3. Click Save.
    Configure the amount of time that elapses before the Successfully synced indicator disappears
    1. In the Setting Purpose column, click offline/ui/hideSuccessfulSyncNotificationAfter
    2. In the Edit Dynamic System settings window, in the Value field, enter the amount of time in milliseconds.
      The default value is 5000.
      For example: If you enter 6000 in the Value field, the app displays the Successfully synced indicator for six seconds.
      Tip: If you do not want to display the Successfully synced indicator, enter 0 in the Value field.
    3. Click Save.
  • Previous topic Customizing synchronization indicators
  • Next topic Offline case packaging optimization during synchronization
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