Creating an installer for a 

BlackBerry UEM

 plug-in

You have the option to create a simple executable installer for a 

BlackBerry UEM

 plug-in. This is an alternative to the basic deployment steps described in Deploy a plug-in to a production BlackBerry UEM domain. You may want to create an executable installer if you want others to install the plug-in on one or more 

BlackBerry UEM

 instances.

What you will need to create an executable installer:

The 
BlackBerry UEM
 plug-in package generated from 
Eclipse
. See Verify that you can compile a plug-in project, or steps 1 to 3 in Deploy a plug-in to a production BlackBerry UEM domain.
The commands for the plugin-deploy.bat batch file, provided below. You can find plugin-deploy.bat in the 
BlackBerry UEM
 installation files. See "plugin-deploy.bat commands" below.
If you want the installer to display a simple UI, a plug-in installer configuration file. See the "Installer UI configuration file" section below.

Each instance of 

BlackBerry UEM

 12.7 or later includes a plugin-deploy.bat batch file in 

<drive>

:\Program Files\BlackBerry\UEM\tools\plugins\onprem. When an administrator installs a 

UEM

 instance, plugin-deploy.bat is populated with values such as the install location and the log file path. You will use this batch file to validate a 

BlackBerry UEM

 plug-in and integrate it with a 

UEM

 installation. For your 

UEM

 plug-in installer, specify the following commands for plugin-deploy.bat:

Command	Description
--plugins " <file_path> "	The absolute or relative file path of the  UEM  plug-in package that was generated from  Eclipse
--GUI " <file_path> "	Optional, use only if you want to display a simple installer UI; the absolute or relative file path of the plug-in installer UI configuration file
--iAcceptEULA	Optional, use only if you want to display a simple installer UI and you want to display an end-user license agreement (EULA) that the user must accept before starting the installation
--update	You must use this parameter if you are upgrading an existing  UEM  plug-in to a new version.

plugin-deploy.bat --plugins “C:\pluginDirectory\example_plugin.zip” --GUI "C:\pluginDirectory\ConfigFile.txt" --iAcceptEULA

You can display a simple UI for the 

UEM

 plug-in installer. The UI consists of the following screens:

Language selection (optional)
: The user selects the language of the text used in the installer (status messages, text on buttons, and so on). You provide the translated text of the product name (full name and short name) in the configuration file.
Splash screen
: Displays the full product name and market version, and provides the initialization status. Provides error messages for common initialization issues (for example, 
UEM
 does not support this version, a later version was found, this product is already installed, and so on). The user clicks Next or Cancel.
License screen (optional)
: The user selects and views a EULA for the product. The user accepts the license, then clicks Install to start the installation. For more information, see the "Adding a license screen" section below.
Installation
: Displays the overall progress of the installation and the progress of the current installation step. If issues occur, this screen displays a corresponding error message.

If you want the plug-in installer to use a simple UI, specify the following properties as key-value pairs in a configuration text file (for example, ConfigFile.txt):

Property	Description
deployer.product.full.name	The full product name that is displayed on the splash screen and on the installation status screens. The specified product name is used for a product folder and log folder in the  BlackBerry UEM  installation files: <drive> :\Program Files\BlackBerry\ <product_name> <drive> :\Program Files\BlackBerry\ <product_name> \Logs
deployer.product.short.name	A short product name that is displayed in the top panel of each installer screen.
deployer.product.version	The product version number that is displayed in the log files. You can specify a version number with up to four version sections in the following format:  x.x.x.x
deployer.market.version	The product version number that is displayed on the splash screen and in the top panel of each installer screen. You can specify a version number with up to four version sections in the following format:  x.x.x.x
deployer.supported.languages.list	A comma-separated list of the languages supported by the installer, represented by language codes. Only the following language codes can be specified: en - English (included by default) fr - French es - Spanish ja - Japanese de - German When a user opens the installer, a language selection window displays the language options that correspond to the codes specified. If no language codes are specified (or only en is specified), the language selection window does not display. If you specify a language code, add the translated text for the necessary installer properties using the following format:  <property> . <language_code> , for example, deployer.product.short.name.es=Inventario

If you want the installer UI to display a license screen, in the folder that contains plugin-deploy.bat (

<drive>

:\Program Files\BlackBerry\UEM\tools\plugins\onprem), you must create a 

Licenses

 folder that contains a 

TXT

 folder.

The 

TXT

 folder must contain:

Text (.txt) files that contain the UTF-8 license text that you want to display. Use a separate text file for each language. For examples, see the 

BlackBerry UEM

 licenses in 

<drive>

:\BlackBerry\UEM\BlackBerry UEM 

<version>

\Licenses\TXT.

An 

sla.ini

 file with sections for each license with a unique ID header in square brackets, the translated strings for each language (an english line is required as the default), and the relative path to the license text file. For example:

[DZ_English]
DisplayName_en=Algeria (English)
DisplayName_es=Argelia (inglés)
InstallSLA=BBSLA_Algeria_English.txt