Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry UEM Integration SDK 12.12
  3. BlackBerry UEM Integration SDK Development Guide
  4. Setting up your BlackBerry UEM plug-in development environment
  5. Configuring your development environment
  6. Create an Eclipse workspace and integrate it with BlackBerry UEM

Create an 
Eclipse
 workspace and integrate it with 
BlackBerry UEM

You must integrate your development environment with a local 
BlackBerry UEM
 installation that is reserved for testing your 
BlackBerry UEM
 plug-in. This gives your 
Eclipse
 environment access to the necessary development resources and dependencies for the 
BlackBerry UEM
 components, including the 
BlackBerry UEM Core
 and the management console, and provides the necessary mechanisms to integrate a 
BlackBerry UEM
 plug-in.
The integration process creates a folder for the plug-in in the 
BlackBerry UEM
 installation files, in 
<drive>
:\Program Files\BlackBerry\UEM\ext. The 
UEM
 Integration plug-in for 
Eclipse
 packages and deploys code to this file path so that you can test the plug-in with your local 
BlackBerry UEM
 installation.
In the 
Windows
 Services, set the start-up type for the 
BlackBerry UEM Core
 and management console services to Manual. Disable automatic restart for both services. Stop the 
BlackBerry UEM Core
 and management console services. After you complete the integration task below, you will configure your development environment to start and run the 
BlackBerry UEM Core
 and management console.
  1. Run 
    Eclipse
     as an administrator and open a workspace.
  2. On the menu, click 
    UEM Plug-in Tools > UEM Integration Setup
    .
  3. For the 
    UEM Root Directory
     field, click 
    Browse
     and navigate to the root folder for the 
    BlackBerry UEM
     installation (for example, C:\Program Files\BlackBerry\UEM).
  4. For the 
    Plug-in Project Root
     field, specify a root folder (for example, C:\example_plugin).
  5. Select the 
    Create Basic Plug-in Projects
     check box.
  6. If you want to enable a background process to scan for discouraged uses of the 
    UEM
     Integration APIs, verify that the 
    Enable Private API validator
     check box is selected.
  7. If you upgraded 
    UEM
     to a new version and you are running the integration process for the first time after the upgrade, select the 
    Regenerate launchers
     check box. This will regenerate the utilities that are used to launch the 
    BlackBerry UEM Core
     and management console from 
    Eclipse
    .
  8. Click 
    OK
    .
  9. The 
    BlackBerry UEM Plug-in
     window lists any 
    BlackBerry UEM
     services that are running that may interfere with the integration process. Select all of the services and click 
    OK
    .
  10. In the 
    BlackBerry UEM Integration SDK Development Environment
     window, specify the ID, name, and version for the 
    BlackBerry UEM
     plug-in that you plan to develop.
    The plug-in ID must:
    • Use the format 
      <company>
      .
      <product>
      .
      <plug-in>
      , where 
      <company>
       is the fully qualified internet address of the company in reverse order (for example, com.company), 
      <product>
       is the name of the product that the plug-in is built for (only required if there is more code to the product than just the 
      BlackBerry UEM
       plug-in), and 
      <plug-in>
       uniquely identifies the plug-in code. For example: 
      com.blackberry.sampleproduct.monitoringplugin
    • Be globally unique and human-readable
    • Meet all criteria when treated as case-sensitive or case-insensitive, must be consistent wherever used (it is recommended to use only lower-case characters)
    • Use ASCII characters with the following conventions:
      • each segment must begin with a letter (a-z) and the remaining characters in a segment must be a letter (a-z) or a number (0-9)
      • segments must be separated by a single period (.)
  11. Click 
    OK
    .
When the process completes, the workspace restarts to apply the configuration changes. You will see the new project structure in the Package Explorer tab.
Project structure following integration with 
BlackBerry UEM
Screenshot of the default Eclipse projects
  • If you run into issues setting up the workspace, review the setup logs under 
    Console > BlackBerry UEM Integration SDK Plug-in Console
     and see Best practices and troubleshooting. After you resolve errors, repeat this task. Clear the 
    Create Basic Plug-in Projects
     check box before you run the integration process again.
  • In the 
    Windows
     Services, restart the 
    BlackBerry UEM
     services, except for the 
    BlackBerry UEM Core
     and the management console services. In the following tasks you will start these services from 
    Eclipse
    .