8.1 Enabling Push Notifications for Android Devices

Firebase Cloud Messaging (FCM) is the new version of Google Cloud Messaging (GCM) that enables a ZENworks MDM Server to send data to an Android device. The data might be a send-to-sync message that informs the device that there is new ZENworks data to be retrieved from the ZENworks MDM Server, or it might be a message with payload that pushes data directly to the device. The ZENworks MDM Server communicates with the FCM service, which then pushes the notification to the device. After receiving the push notification, the device contacts the ZENworks MDM Server directly to provide the requested information or to receive the changes.

To connect to the FCM service, you need to create a Firebase project in the Firebase console and obtain a .JSON file (that contains the Project Number) and a Server Key. The .JSON file and the Server Key are then used to configure ZENworks’ access to the FCM service.

For existing users of the GCM project, we strongly recommend that you migrate to the FCM service in order to benefit from its new features.

However, if you do not want to migrate to the FCM service, then ZENworks will continue using the existing GCM configuration to communicate with enrolled mobile devices. If you want to view the existing GCM configuration details, then navigate to Configuration > Management Zone Settings > Push Notifications > Google Cloud Messaging (Obsolete). This page lets you only view the GCM configuration details and you will be unable to edit any of the configuration details.

If you want to create a new FCM project, then refer to Create a Firebase Project.

If you have already created a GCM project and want to migrate to the FCM service, then refer Importing a GCM Project to Firebase. This ensures that the Project Number specified in the GCM project and the FCM project are the same. If the Project Number does not match, then communication between ZENworks and already enrolled mobile devices will be discontinued.

IMPORTANT:As of April 10, 2018, Google has deprecated GCM. Therefore, it is mandatory to migrate to the FCM service.

8.1.1 Prerequisites

MDM Server: An MDM role is assigned to a Primary Server. For more information, see Configuring an MDM Server.

8.1.2 Create a Firebase Project

Follow these steps, if you want to create a Firebase project. However, if you have already created a GCM project and want to import the project to FCM, then go to Importing a GCM Project to Firebase.

On the Getting Started with Mobile Management page, navigate to the Android Devices section, click Configure FCM to display the Firebase Cloud Messaging page. Alternatively, from the left hand side navigation pane of ZCC, navigate to Configuration > Push Notification > Firebase Cloud Messaging.
Click Firebase Developers Console, which will direct you to the Firebase console at https://console.firebase.google.com.
Sign in using your Google account credentials.

As a best practice, we recommend that this should be a Google account created specifically for managing your corporate Google services and not a personal Google account.
Click Add Project.
Specify a Project Name and click Create Project.
Select Add Firebase to your Android App in the Overview page.
Specify the Android Package Name for the ZENworks Agent App, that is, com.novell.zapp. Click Register App.
Click Download google-services.json to download the .JSON file in your preferred location. Click Continue and then click Finish.
Click appearing next to Project Overview and select Project Settings.
Select the Cloud Messaging tab. You can now view the Server Key. Note down this Server Key.
Exit the Firebase Console, then continue with Step 12.
In ZCC, on the Firebase Cloud Messaging page configure ZENworks with the .JSON file and Server Key:

Before importing the .JSON file, ensure that the file contains the firebase URL parameter. To add the parameter, edit the file and specify the following: firebase_url: https://(project_id).firebaseio.com

For example: In the following file, the firebase_url parameter is missing:
```
"project_info": {
    "project_number": "973364669284",
    "project_id": "fir-project-75920",
    "storage_bucket": "fir-project-75920.appspot.com"
```
If the project ID is fir-project-75920, then you need to add the firebase_url parameter in the following manner:
```
"project_info": {
    "project_number": "973364669284",
    "firebase_url": "https://fir-project-75920.firebaseio.com",
    "project_id": "fir-project-75920",
    "storage_bucket": "fir-project-75920.appspot.com"
```
NOTE:project_id in the .JSON file is unique to the Firebase project.
1. Click the Enable Firebase Cloud Messaging check box to turn on the option.
2. Specify the following fields with the information you generated in the Firebase Developers Console:
  - Project JSON file: Upload the .JSON file that you have downloaded from the Firebase Console
  - Server Key: Specify the Server Key for your Firebase project.
  - Key activation date: Specify the key’s activation date.
  - Google User ID: Specify the Google account ID used to log in to the Firebase Developers Console and create or import the Firebase project.
3. Click Test Server Key to validate that the information is entered correctly and the key is active. This option will test the connection to the FCM service from each of the MDM Servers configured in the zone. If the connectivity fails from one or more MDM Servers, then the failed servers are listed.
4. Click OK to save your Firebase Cloud Messaging configuration.

8.1.3 Importing a GCM Project to Firebase

If you have already created a GCM project, then refer to the following steps to import the GCM project to FCM:

On the Getting Started with Mobile Management page, navigate to the Android Devices section, click Configure FCM. The Google Cloud Messaging page is displayed. Click Configure FCM, which will re-direct you to the Firebase Cloud Messaging page.
Click Firebase Developers Console, which will direct you to the Firebase console at https://console.firebase.google.com.
Sign in using your Google account credentials that was used to create the existing GCM project.
Click Add Project.
Click the Project Name drop-down menu and select the GCM project that you want to import. Click Add Firebase.

If you have already performed steps 4 and 5, then continue with step 6.
Select Add Firebase to your Android App in the Overview page.
Specify the Android Package Name for the ZENworks Agent App, that is, com.novell.zapp. Click Register App.
Click Download google-services.json to download the.JSON file in your preferred location. Click Continue and then click Finish.
Click appearing next to Project Overview and click Project Settings.
Select the Cloud Messaging tab. You can now view the Server Key. Note down this Server Key.
Exit the Firebase Developers Console, then continue with Step 12.
In ZCC, on the Firebase Cloud Message page configure ZENworks with the .JSON file and Server Key:

Before importing the .JSON file, ensure that the file contains the firebase URL parameter. To add the parameter, edit the file and specify the following: firebase_url: https://(project_id).firebaseio.com

For example: In the following file, the firebase_url parameter is missing:
```
"project_info": {
    "project_number": "973364669284",
    "project_id": "fir-project-75920",
    "storage_bucket": "fir-project-75920.appspot.com"
```
If the project ID is fir-project-75920, then you need to add the firebase_url parameter in the following manner:
```
"project_info": {
    "project_number": "973364669284",
    "firebase_url": "https://fir-project-75920.firebaseio.com",
    "project_id": "fir-project-75920",
    "storage_bucket": "fir-project-75920.appspot.com"
```
NOTE:project_id in the .JSON file is unique to the Firebase project.
1. Click the Enable Firebase Cloud Messaging check box to turn on the option.
2. Fill in the following fields with the information you generated in the Google Developers Console:
  - Project JSON file: Upload the .JSON file that you have downloaded from the Firebase Console
  - Server Key: Specify the Server Key for your Firebase project.
  - Key activation date: Specify the key’s activation date.
  - Google User ID: Specify the Google account ID used to log in to the Firebase Developers Console and create or import the Firebase project.
3. Click Test Server Key to validate that the information is entered correctly and the key is active. This option will test the connection to the FCM service from each of the MDM Servers configured in the zone. If the connectivity fails from one or more MDM Servers, then the failed servers are listed.
4. Click OK to save your Firebase Cloud Messaging configuration.

8.1.4 Importing a GCM Project to Firebase

If you have already created a GCM project, then refer to the following steps to import the GCM project to FCM:

On the Getting Started with Mobile Management page, navigate to the Android Devices section, click Configure FCM. The Google Cloud Messaging page is displayed. Click Configure FCM, which will re-direct you to the Firebase Cloud Messaging page.
Click Firebase Developers Console, which will direct you to the Firebase console at https://console.firebase.google.com.
Sign in using your Google account credentials that was used to create the existing GCM project.
Click Add Project.
Click the Project Name drop-down menu and select the GCM project that you want to import. Click Add Firebase.

If you have already performed steps 4 and 5, then continue with step 6.
Select Add Firebase to your Android App in the Overview page.
Specify the Android Package Name for the ZENworks Agent App, that is, com.novell.zapp. Click Register App.
Click Download google-services.json to download the.JSON file in your preferred location. Click Continue and then click Finish.
Click appearing next to Project Overview and click Project Settings.
Select the Cloud Messaging tab. You can now view the Server Key. Note down this Server Key.
Exit the Firebase Developers Console, then continue with Step 12.
In ZCC, on the Firebase Cloud Message page configure ZENworks with the .JSON file and Server Key:
1. Click the Enable Firebase Cloud Messaging check box to turn on the option.
2. Fill in the following fields with the information you generated in the Google Developers Console:
  - Project JSON file: Upload the .JSON file that you have downloaded from the Firebase Console
  - Server Key: Specify the Server Key for your Firebase project.
  - Key activation date: Specify the key’s activation date.
  - Google User ID: Specify the Google account ID used to log in to the Firebase Developers Console and create or import the Firebase project.
3. Click Test Server Key to validate that the information is entered correctly and the key is active. This option will test the connection to the FCM service from each of the MDM Servers configured in the zone. If the connectivity fails from one or more MDM Servers, then the failed servers are listed.
4. Click OK to save your Firebase Cloud Messaging configuration.

8.1.5 Re-configuring FCM

If you have already configured FCM and want to re-configure it, then it is mandatory that you remove the existing FCM setting before you go ahead and configure a new FCM setting. To remove the setting in ZCC:

Navigate to Configuration > Management Zone Settings > Push Notifications > Firebase Cloud Messaging
Click Remove.

After removing the FCM configuration, you can now proceed to configuring a new FCM setting by following the procedure in Create a Firebase Project. After re-configuring FCM, ensure that all the enrolled Android devices in the zone sync with the ZENworks server to obtain the latest changes.