Skip to content

Setting up App Notifications

Business Portals utilizes app notifications for the Business Portals mobile app to inform users of important events, such as order confirmations, order status updates, and more. The platform allows the creation of custom app notifications, enabling dynamic integration with data for a personalized user experience. Additionally, this feature supports multilingual capabilities, allowing notifications to be sent in the user's preferred language.

Creating a New App Notification

To create a new app notification for the mobile app, follow these steps:

  1. In the Business Portals role center page, click on the Portal Setup in the ribbon bar.
  2. Navigate to the App Notifications.
  3. Click on the New button to create a new app notification.
  4. Enter the Code as a unique identifier for the app notification.
  5. Fill in the Description field with a brief description of the app notification. This field will only be visible to the Business Central user.
  6. Fill the Icon field with the FontAwesome icon for the app notification. This icon will be displayed in the mobile app notification. If the icon is left empty, no icon will be shown in the app.

    Warning

    • Ensure that the class name is correct and complete to avoid any issues with the icon display.
    • Always take only the class name from HTML code, not the full HTML code.
      • <i class="fa-solid fa-house"></i>
      • fa-solid fa-house
  7. Fill in the Icon Color field with the a desired color indication for the app notification.

    Info

    The icon color needs to be in hex code such as #e0f542 will result a yellow color. If the color is left empty, the app will automatically use the default app color theme.

  8. Fill the Source Table using the lookup function. Choose a source table that suits the requirements of the notification.

  9. Configure the Placeholder as needed.
  10. In the Lines area click on the Language Code and select the desired language.

    Info

    It is recommended to fill every language code that the Business Portal offers to the user based on the language configuration.

  11. Fill the Title for the App Notification.

  12. Fill the Message for the App Notification.

Tip

The pro icon from Fontawesome can also be used in Business Portals.

Example: Delivery Confirmation Notification

In this example, we will demonstrate how to create a notification for delivery confirmation. Completely utilizing the Source Table and Placeholder. Here, we will begin directly from the App Notification card, which can be accessed by following through the previous steps.

  1. Enter the code for the App Notification. In this case, we will name it as ORDER CONFIRMATION.
  2. Fill in a brief descrption for the Business Central users. In this case, we will write it as Delivery order confirmation.
  3. Next we give a box icon for the icon that will later be shown in the app, we will write it fa-solid fa-box in the Icon field and it will show in the app. Feel free to try another icon combination.
  4. For this example the Icon Color will be left empty, the app will then automatically use the default app color theme.
  5. As this notification is for an item delivery confirmation, we will select the Source Table as Item or Table number 27.
  6. To utilize the source table, open the Placeholder card by clicking the number in the Placeholder field, or by usint the action Notification Placeholder in the ribbon bar.
  7. In the Placeholder card, a new Placeholder Text will be automatically created, as it is the first placeholder it will be automatically set as %1. Use the lookup on the Field Name field, this will list all of the fields that are available from the selected Source Table.
  8. In this example, we want the %1 placeholder to hold the item name, therefore choose the Description.
  9. Close the table after finish setting up the placeholder.
  10. Now in the Lines area, click on the Language Code dropdown and choose the language that are configured in the Business Portals - Languages.
  11. For this example we will use English, ENU will be the Language Code and title will be written as Delivery Confirmation.
  12. Write the message and use the placeholder, here we will use the example Your %1 is delivered.
  13. The configuration is now finish, and this notification can be used.

This concludes the example on how to set up an App Notification. If the item name is OFFICE Chair the app will have the icon with the title Delivery Confirmation and the message Your OFFICE Chair is delivered for its English notification.

Using the App Notification

The App Notification can be utilized in two ways: the first method involves using Processes and Status, while the second method is through a codeunit action.

Using Processes and Status

To utilize app notifications for status updates and processes, the corresponding statuses and processes must first be created. Once established, app notifications can be configured in the status to trigger when a specific status is reached.

See also