Skip Navigation

Deploy a plug-in to a production 
BlackBerry UEM
 domain

Follow these instructions when your plug-in is complete and ready to deploy to a production 
BlackBerry UEM
 domain. The deployment process will stop the 
BlackBerry UEM
 services for a short time, so you should perform this task when there will be minimal impact to users.
If you want to create a simple executable installer that automates this process, see Creating an installer for a BlackBerry UEM plug-in instead.
Whenever you update or create a new version of a plug-in, follow this process again to re-deploy the snap-in.
  1. On your development computer, run the command prompt as an administrator and change the directory to the plug-in root folder (for example, C:\example_plugin).
  2. Type 
    g zip
    .
  3. Press ENTER.
    After g.bat builds the plug-in package, you can find it in a “dist” folder in the root folder that you specified (for example, C:\example_plugin). The .zip file is named after the plug-in ID.
  4. Copy the .zip file to each computer that hosts a production 
    BlackBerry UEM
     instance.
  5. On each computer that hosts a production 
    BlackBerry UEM
     instance, open the command line as an administrator and change the directory to 
    <drive>
    :\Program Files\BlackBerry\UEM\tools\plugins\onprem. Execute one of the following commands:
    • To install a plug-in, execute: 
      plugin-deploy.bat --plugins "
      <file_path>
      "
    • To upgrade an existing plug-in to a new version, execute: 
      plugin-deploy.bat --plugins "
      <file_path>
      " --update
       
    "
    <file_path>
    " is the location of the plug-in package (.zip). The file path must be enclosed in double quotation marks. If you want to integrate more than one plug-in, you can type a comma-separated list of file paths in one set of double quotation marks (for example, "
    <file_path>
    ,
    <file_path>
    ,
    <file_path>
    ").
    The command validates the plug-in, integrates it with the 
    BlackBerry UEM
     components, and restarts the 
    BlackBerry UEM
     services. This process may take some time (approximately 10 minutes). After the plug-in is integrated, the plug-in files are located at 
    <drive>
    :\Program Files\BlackBerry\UEM\ext\.