Sample
BlackBerry UEM
plug-in

The

BlackBerry UEM Integration SDK

package includes a functional

UEM

plug-in sample that demonstrates several key use cases. The sample is found in the Samples folder in the SDK package.

To import the sample projects into

Eclipse

, extract the Samples folder to a directory on your development computer, then follow the instructions in Create an Eclipse workspace and integrate it with BlackBerry UEM, with the following changes:

For the

Plug-in Project Root

, specify the root of the sample plug-in files.

Do not select

Create Basic Plug-in Projects

Accept the prompt to auto-import the existing projects from the plug-in file structure that you specified.

For an explanation of the different projects and how they relate to each other, review BlackBerry UEM plug-in project structure.

Explore the sample plug-in to gain a better understanding of how to build your code and how a plug-in interacts with the

UEM

platform to add new functionality to the code base and to display new UI elements in the management console.

A brief introduction to some of the key packages:

Package	Description
Project: core.server
com.blackberry.snapin.sample.core.server.configuration > ConfigurationController.java	Demonstrates how to get configuration data for a plug-in from the UEM database and how to set configuration data in the database.
com.blackberry.snapin.sample.core.server.eventing > SampleEventListener.java	Demonstrates how a plug-in can subscribe to and handle synchronous or asynchronous events from the UEM platform.
com.blackberry.snapin.sample.core.server.execution > SampleExecutionCallback.java	Demonstrates how a plug-in can call out to a REST endpoint and return a success or retry on failure.
com.blackberry.snapin.sample.core.server.rest.controller > SampleProfileController.java	Demonstrates how a plug-in can create and add a new profile definition.
com.blackberry.snapin.sample.core.server.rest.controller > SampleUserController.java	Demonstrates how a plug-in can perform different actions for user accounts (for example, retrieve, create, delete, and so on).
com.blackberry.snapin.sample.core.server.util > SampleRestEndpointController.java	Demonstrates how a plug-in can expose a REST endpoint for external systems and software to contact to exchange data with the plug-in.
Project: ui.client
com.blackberry.snapin.sample.ui.client > ClientSnapin.java	The main entry point that is invoked when the UI client initializes a plug-in. The UEM platform registers providers for the plug-in’s UI elements and displays the UI elements that have been defined (for example, a new icon for the plug-in on the user details screen, a new menu item on the policies and profiles screen, a new settings screen, and so on).
com.blackberry.snapin.sample.ui.client.features	Demonstrates how to use the features API.
com.blackberry.snapin.sample.ui.client.menu.dynamic	Demonstrates how to add a dynamic menu.
com.blackberry.snapin.sample.ui.client.navigation	Demonstrates how to navigate to another screen in the management console.
com.blackberry.snapin.sample.ui.client.sampleIFrame	Demonstrates how to add external content into the UEM management console using a frame model.
com.blackberry.snapin.sample.ui.client.settings	Demonstrates how to add plug-in UI elements to the settings screens.
com.blackberry.snapin.sample.ui.client.userdetails	Demonstrates how to add plug-in UI elements to the user details screens.
com.blackberry.snapin.sample.ui.client.usergroupdetails	Demonstrates how to add a tab to the group details screen that is specific to your plug-in.
com.blackberry.snapin.sample.ui.client.users	Demonstrates how to add plug-in UI elements to the users screens.
com.blackberry.snapin.sample.ui.client.usersandservices	Demonstrates how to add plug-in UI elements to the users and services screens.
Project: ui.server
com.blackberry.snapin.sample.ui.server > SnapinConnection.java	Demonstrates how the UI server handles calls from the UI client to retrieve data from the UEM Core and provides the data to the UI client.

Sample BlackBerry UEM plug-in

Sample
BlackBerry UEM
plug-in