Push templates troubleshooting

A push template is rendered only when the app uses Messaging 3.13.0 or later and has the UI Builder plugin added. In every other case, the push is still displayed, as a standard notification built from the standard payload keys.

Push template campaigns on earlier Messaging versions

A campaign that sends a push template keeps working on apps with a Messaging version earlier than 3.13.0, including a new campaign that uses the ajo_basic template. The push is displayed as a rich media push was displayed before push templates: when it has an image (adb_image), the image is shown with the Android BigPictureStyle notification style; without an image, the notification shows the title and body.

This works because a push template payload still includes the standard payload keys, such as adb_title, adb_body, and adb_image. Earlier Messaging versions read those keys and ignore adb_template_type and adb_template_properties. Fields that only a template uses, such as the big text template's collapsed text and large icon, are not shown.

UI Builder plugin not added

With any Messaging version, an app that does not add the UI Builder plugin displays a push template as a standard notification, as described above. To render the templates, add the plugin with MobileCore.addPlugins(NotificationBuilderPlugin()). See Add the UI Builder plugin to your app.

With Messaging 3.13.0 or later, the Adobe Journey Optimizer extension also logs a warning and reports a no_plugin diagnostic event.

Template not rendered with the UI Builder plugin added

• The plugin could not build the template. The plugin builds only ajo_basic and ajo_bigtext. For any other template type, or when the notification cannot be built, the Adobe Journey Optimizer extension logs a warning and displays a standard notification. No diagnostic event is reported for this case.
• The app displays push notifications itself. Building the notification yourself from MessagingPushPayload does not use the plugin, so the push is displayed as a standard notification. Use automatic display and tracking instead of manual display and tracking.

Diagnostic event

When a push template arrives and the UI Builder plugin is not added, the Adobe Journey Optimizer extension (Messaging 3.13.0 or later) dispatches this event on the Mobile Core event hub. The event is not sent to the Edge Network, so it is not written to the Adobe Journey Optimizer tracking dataset. Inspect it with Adobe Experience Platform Assurance, or process it on the device with a rule.

Event data:

To match the event in a rule, use ~type equal to com.adobe.eventType.messaging, ~source equal to com.adobe.eventSource.errorResponseContent, and category equal to pushTracking.renderError. Match on category, because the Live Updates no_plugin event uses the same subcategory.

See also: Basic template, Big text template, Push templates overview.