Push Notification
Android Configure Firebase Cloud Messaging
For FIS Retirement App to send Android push notifications, it must communicate with Firebase Cloud Messaging.
The following section is a step-by-step guide:
- Create a Firebase account.
- Create a Firebase project.
- Find your Firebase Project ID.
- Find your Firebase Legacy server key, Sender ID and Server key.
- Download google-services.json
- Complete the configuration of your Firebase project via Relius portal.
After completing the step below, you will have successfully set your android app with Firebase push notification support.
- Navigate to https://firebase.google.com/
-
Click Get Started.
- Login with your organisation's Google account.
-
On the welcome screen, click "Add project".
- Enter a name for your project.
-
Accept terms of service & Click "Continue".
-
Click Continue.
-
Accept terms of service & Click "Create Project".
- Click "Continue" to open your project.
-
From the left-side menu, click on the settings icon to open the project settings page.
-
On the General tab of setting page locate and copy the Project ID.
You may want to name your project as 'CompanyNameAppProject'. Ex: ABCRetirementAppProject
Note: Project ID will not always be the exact same as the Project name. -
Open the Cloud Messaging settings page by click on the tab.
-
Locate the Legacy server key, Server key, Sender ID and copy it.You use this value to configure your Azure Notification Hub.
-
Locate the Legacy server key, Server key, Sender ID and copy it.You use this value to configure your Azure Notification Hub.
Note: Please do not use Web API key that can be found on the General settings page. -
Under Project settings General tab, click on Android Icon.
-
Fill the Android package name, nickname (optional) and click on "Register App". DO NOT use com.fis.relius.dev instead use package name provided by FIS.
Note:The package name should be available in Relius Portal or ask FIS team -
Download google-services.json
file and click Next. Similarly, click Next on the next step and skip the last step to complete the process.
Note: google-services.json file will be used in your app build process by FIS team. Please share these file with FIS team as soon as possible.
Congratulations! You have now successfully enabled Firebase Cloud Messaging(FCM) and linked it to your android app.
Configuration in Relius Portal
- Make sure you have copied the Project ID, Server Key, Sender ID and Legacy server key from Firebase Console.
- Make sure you have downloaded the google-services.json file from the firebase console.
- Login to Relius.net and go to Mobile App Onboarding > Build Settings.
-
Under Firebase enter Project ID, Legacy server key, Server Key and Sender ID in appropriate field, and upload google-services.json file.
Note: If you are not able to use Relius Portal, please email this configuration to FIS team at ReliusAdminMobileAppSuppt@fisglobal.com
iOS Creating a Push Notification Certificate
To use Retirement App to send push notification to an iOS app, we need to create push certificate
If you have already invited FIS as an Admin to your App Store Connect account, no further action needed on your part.
If you have not invited FIS as an Admin Role, Please reach out to FIS team for step by step guide to create Push Certificate.
Configure Azure Notification Hub
-
Creating a notification hub in Azure
FIS Retirement App push notification use Azure notification hubs for delivering the notifications (see Microsoft Azure Notification Hubs).You therefore need to have a valid Microsoft Azure subscription before moving forward. Visit https://azure.microsoft.com to create a subscription if you do not yet have one.
Note:If you don't have organization's Azure Subscription, you can go with Free or Pay-As-you-Go Subscription. Do not select Microsoft Support and make sure you Do not Pay anything here.Do the following steps to create a new notification hub in Azure:
Note:Make sure you have sign-up for Azure and valid subscription before begin for bellow steps.
- Sign in to Azure Portal
-
Click Create a resource and Search for "Notification Hub".
-
Click on "Create".
- In the Notification Hub field, enter a unique name.
-
In the Create a new namespace field, enter a namespace name.
If you already have a namespace that you want to create the hub in, click the Select Existing link and then select Create.
- Select a value from the Location drop-down list box. This value specifies the location in which you want to create the hub.
- Select an existing resource group Resource Group (or create a name for a new resource group) and Subscription.
- Select suitable price tier (for details, see Notification Hubs pricing).
- Select Create.
-
Setting up an Azure notification hub for push notifications
After you have create an Azure notification hub, it need to be configured for different mobile platform. You can find the settings for the available notification service by doing these steps.
- Sign in to Azure Portal.
-
Select All Resources
-
From the list, Click Notification Hub that was created according to the instruction in [Creating a notification hub in Azure](#creating-a-notification-hub-in-azure)
-
Under Settings > Select "Apple(APNS)".
Select Authentication mode Certificate and Application mode Production.
Upload Certificate(Push Certificate) with it's password and then select Save.
You can request this configuration settings(Push Certificate and Password) from FIS Team at ReliusImplementation@fisglobal.onmicrosoft.com
Your service is now configured to work with push notifications on iOS.
5. Under
Settings > Select "Google(GCM/FCM)".
Enter FCM Legacy server key that you obtained from the Firebase console
Your service is now configured to work with Firebase Cloud Messaging.
Enabling push notification in Relius Admin.
-
Configuration in Relius Admin:
- Sign in to Azure Portal.
- Select All Resources.
- From the list, Click Notification Hub that was created according to the instruction in Creating a notification hub in Azure.
-
Under Settings > Select "Properties".
Copy the value of NAME field.
You use this value to configure Relius Admin later.
-
Under Manage > Select "Access Policies".
Copy the value of DefaultFullSharedAccessSignature.
You use this value to configure Relius Admin later.
- Open Relius Administration and Select Utilities > VRU/Web Administration > Web Options.
- Select your site and click Load.
-
Once site options loaded Go to Mobile App tab > Select Push Notification Settings .
- Check Enable Push Notification Checkbox.
- In Push notification connection string , paste value of DefaultFullSharedAccessSignature field, which you obtained in step 5.
- In Notification hub path, paste value of NAME field, which you obtained in step 4.
-
Select Save.
Congratulations! Your Relius Admin is now configured to work with Azure Notification Hub.
-
Send Notifications to Your Users:
Keep your users informed with notifications. Whether you need to announce something important, you would like to send reminder, or you have some suggestions for participants, the Notifications tool provides a quick and easy way to communicate with everyone who has downloaded your app.
Note: Notifications require network connectivity (WiFi or cellular data)
-
Types of Notifications:
-
In App Notifications/Alert Messages:
All Notifications/Messages sent will be stored in the Messages Inbox. In the app, users will see an unread message indicator on bell icon.
Note: In app notification or alert messages will not alert the user outside of the app. Users will only know they have a message waiting for them when they open the retirement app and check the messages inbox there.
-
Push Notifications:
Notifications generated by a mobile app while the app is not actively in use are called push notifications.
Push Notifications are alerts that appear outside of the app on users� devices. These messages are also stored in the message inbox for later viewing.
-
In App Notifications/Alert Messages:
-
How to send a Notification:
In Relius Admin go to Utilities > VRU/Web Administration > Web Customization > Messaging > Add Message.
Create web message by providing Subject and Message body.
In Rules & Options check Post Message to Mobile App & Post as push notification.
Note: Only Subject text will send as a Push Notification, message body will be available inside mobile app messages inbox.
Description Subject Enter the content of push notification here. Limited to 155 characters per notification. Message Enter Message body here, You can include web address URLs in the message Body. Message body can be viewed from app inbox.
-
Test Your Push Notification:
Testing your push notifications before sending them out to the customers is always a good idea.
Anyone with valid login account can be a test user. You can send your test push notifications to multiple users at a time (same as web message/email).
Here are a few things to keep in mind when testing a push notification:
- Test users must first install your mobile app on their smartphone.
- Test users must log into app at-least one time to receive push notifications.
- Test users must select Agree in the app when asked to receive.
- Notification will be sent immediately- when you process/post message from RA
To test a push notification, follow the step bellow:- Ask your test user to install your live app onto a smartphone.
- Ask your test user to log in or register an account with your app.
- In your Relius Admin Desktop, create new push notification ( Utilities > VRU/Web Administration > Web Customization > Messaging > Add Message)
- Process or Post your message in RA Desktop to complete the process(Processing > Notifications).
-
Best Practices For Push Notifications:
The best push notification are those that are short, personal and actionable.
In general, iOS users see around 120 characters, while Android devices only show about 40 characters without the notification being expanded. Because of this, your users may only see the first half of a sentence when your push notification pops up.
To make the most of this, use these tips:
- Try to place the most important keywords at the beginning.
- Shorten the notification to one line, if possible.
- Shorten the notification to one line, if possible.
-
Types of Notifications:
FAQ - Frequently asked questions
- Firebase Cloud Messaging:
-
What is Firebase Cloud Messaging?
Firebase Cloud Messaging is Google's solution for sending push notifications to your users. -
What information do I need to save and provide to FIS team?
To use Firebase Cloud Messaging for push messaging you need Project ID, Server Key, Sender ID, Legacy server key and the google-services.json file. -
What happens if I enter an incorrect Legacy server key,Server Key and/or Other Info?
Your app will not be able to send push messages to your users, and FIS will not be able to configure your Firebase Cloud Messaging project. -
Can I view statistics for push messages sent to my FIS Retirement app(s)?
Yes, you can view the statistics for the push messages you've sent to android users. -
Is Firebase Cloud Messaging free?
Yes. The usage of Firebase Cloud Messaging is free. -
Can I use other features Firebase offers in FIS Retirement App?
FIS Retirement apps only use Firebase Cloud Messaging for sending push messages. -
What happens to my app when no Firebase account is linked?
FIS team will not be able to build your android application without Firebase account information.
-
What is Firebase Cloud Messaging?
- Azure Notification Hubs:
-
What is Azure Notification Hubs?
Notification Hubs is Microsoft's solution for sending push notifications to Android and iOS platform. FIS Retirement app is uses Hubs to send and mange user device for push notification. -
Can I view statistics for push messages sent to my FIS Retirement app(s)?*
Yes, you can view the combined android and iOS statistics for the push messages, registered devices(android/iOS) with your app. -
What is the price model for Notification Hubs?
The latest pricing details can be found on the Notification Hubs Pricing page.
-
How long does it take for sent push notifications to reach my device?
In a normal-use scenario, where the incoming load is consistent and even, Azure Notification Hubs can process at least 1 million push notification sends a minute. This rate might vary depending on the number of tags, the nature of the incoming sends, and other external factors. -
Is there any latency guarantee?
Because of the nature of push notifications (they are delivered by an external, platform-specific PNS(Push Notification Service i,e FCM for Android, APNS for iOS ), there is no latency guarantee. Typically, the majority of push notifications are delivered within a few minutes. -
Which PNS Credential require to enter in Notification Hub?
When a mobile app is registered with a platform's developer portal (for example, Apple or Google), an app identifier and security tokens are sent. The app backend provides these tokens to the platform's PNS so that push notifications can be sent to devices. Security tokens can be in the form of certificates (for example, Apple iOS or Windows Phone) or security keys (for example, Google Android). They must be configured in notification hubs. Configuration is typically done at the notification-hub level, but it can also be done at the namespace level in a multi-tenant scenario.
-
What is Azure Notification Hubs?