Configure an application control policy to support peripherals using Event Injection (KeyStroke Injection) API

Article ID: KB04219

Type: Support Content

Last Modified: 11-12-2013

 

Product(s) Affected:

  • BlackBerry Enterprise Server
CollapseEnvironment
  • BlackBerry Enterprise Server 4.0 and later
  • BlackBerry smartphones
  • BlackBerry 6 to 7.1
  • BlackBerry Device Software 4.0 to 5.0
CollapseOverview

Peripheral devices (for example, Bluetooth enabled keyboards or barcode scanners) can use the EventInjector application programming interface (API) to simulate events such as user interface (UI) navigation and key presses on the BlackBerry smartphone. In order for these calls to be allowed on BlackBerry smartphones connected to the BlackBerry Enterprise Server, Event Injection must be enabled by the BlackBerry Enterprise Server administrator through Application Control for the application component of the peripheral.

To configure an application control policy to support peripherals using Event Injection (KeyStroke Injection) API, the following tasks must be completed.



For BlackBerry Enterprise Server 5.0:

Task 1 - Index the third-party application and third-party software

  1. On the BlackBerry Enterprise Server or any network-enabled computer, create a new folder.
  2. Right-click the folder and select Properties.
  3. Click the Sharing tab.
  4. Click Share this folder.
  5. Click Permissions.
  6. Select the Full Control (including Change and Read access) option and close the Permissions window.

Note: If sharing of sub-folders within the Program Files directory is prohibited or not desirable, a folder can be created in \Research In Motion\Shared\Applications\Refer to the BlackBerry Enterprise Server 5.0 Administration Guide for more information.

Task 2 - Define the share in the BlackBerry Administration Service

  1. In the BlackBerry Administration Service, on the left pane, expand BlackBerry Solution Topology > BlackBerry Domain > Component View.
  2. Select BlackBerry Administration Service.
  3. Scroll to the bottom and select Edit Component.
  4. In the Software Management area, in the field next to BAS Application Shared Network Drive, type \\<hostname>\sharename.
  5. Select Save all.

Task 3 - Publish the application

  1. In the left-pane, under BlackBerry solution management, expand Software Applications.
  2. Select Add or Update Applications.
  3. Browse to a ZIP file containing the ALX and COD that is to be deployed, and click Next.
  4. Click Publish Application.
  5. Confirm that a new folder exists for the application under the Applications folder in the share created in Task 1.
  6. Confirm that the PkgDBCache.xml and Specification.pkg files exist in this new folder.

Task 4 - Enable Event Injection for the third-party application

  1. In the left-pane, under BlackBerry solution management, expand Software Applications.
  2. Select Manage Applications.
  3. Click the Application Name.
  4. Click the Application Version.
  5. Select the Application Control Policies tab.
  6. Click Edit Application.
  7. Perform one of the following:
    • If the application will be a Required Application:
      1. Type a name for the application control policy under Required Application Control Policy Name.
      2. (Optional) Type a description.
      3. Change the Is access to the event injector API allowed setting to Allow.
      4. Scroll up and click the plus (+) symbol to add the application control policy to the application.
    • If the application will be an Optional Application:
      1. Type a name for the application control policy under Optional Application Control Policy Name.
      2. (Optional) Type a description.
      3. Change the Is access to the event injector API allowed setting to Allow.
      4. Scroll up and click the plus (+) symbol to add the application control policy to the application.
  8. Click Save All.
    Note: No existing software configurations containing this application may exist in order for this setting to be saved successfully.

Task 5 - Add the application to a Software Configuration

  1. Open the BlackBerry Administration Service.
  2. On the left pane, expand Software.
  3. Select Create a software configuration.
  4. Enter the name of the software configuration.
  5. Set the Disposition for unlisted Applications setting to Optional.
  6. Set the Application Control Policy for unlisted applications setting to Optional.
  7. Click Save.
  8. Click View Software Configuration List and select the new software configuration.
  9. Click Edit software configuration.
  10. Click the Applications tab.
  11. Click Add Applications To Software Configuration.
  12. Click Search.
  13. Check the box beside the name of the new software configuration application.
  14. Set the Disposition setting to Required or Optional.
  15. Set the Deployment setting to Wireless.
  16. Verify the Application Control Policy is set to the one created in Task 4.
  17. Click Add to Software Configuration.
  18. Click Save All.

Task 6 - Assign the Software Configuration to users as normal




For BlackBerry Enterprise Server 4.x:

Task 1 - Index the third-party application and third-party software

  1. On the BlackBerry Enterprise Server, go to C:\Program Files\Common Files\Research In Motion\Shared.
  2. Create a new folder and name it applications.
  3. Go to C:\Program Files\Common Files\Research In Motion\Shared\applications.
  4. Create a new folder for the third-party application and name it myapplication.
  5. Copy the BlackBerry smartphone installation files (the ALX and COD files) to the myapplication folder.
  6. To index the applications listed in this directory, open a command prompt and type C:\Program Files\Common Files\Research In Motion\AppLoader.
  7. Type Loader.exe /index and press Enter.
  8. Share the C:\Program Files\Common Files\Research In Motion\ folder on the network as read-only.
    Note: If you want to add new software to the indexed software list, run the Loader.exe /index command again in order for the software to be listed in the software configuration screen.

Task 2 - Enable Event Injection for the third-party application

For BlackBerry Enterprise Server 4.1:

  1. On the computer hosting the BlackBerry Enterprise Server, open BlackBerry Manager.
  2. In the left pane, click BlackBerry Domain.
  3. In the right pane, select the Software Configurations tab.
  4. Select a software configuration and click Edit Software Configuration or click Add New Configuration.
  5. Type a name for the new configuration. 
  6. (Optional) Type a description for the new configuration.
  7. In the Device Software Location field, enter the Universal Naming Convention (UNC) path of the shared folder C:\Program Files\Common Files\Research In Motion. The standard UNC format is \\servername\sharename\path\filename.
    Note: For more detailed information on BlackBerry Device Software Configurations, see the appropriate BlackBerry Enterprise Server 4.1: System Administration Guide.
  8. Click Policies.
  9. Complete one of the following:
    • To modify an existing application control policy, select it from the left pane and click Properties.
    • To create a new application control policy, click New and type the required information. For more information, see the BlackBerry Enterprise Server 4.0: Handheld Management Guide.
  10. Locate the label for Event Injection and change the setting to Allowed.
  11. Click OK on the Properties window and the Policies window.
  12. Expand the Application Software tree.
  13. Complete one of the following tasks:
    • To enable Event Injection for one third-party application, in the Policy column, select the appropriate application control policy from the drop-down list.
    • To enable Event Injection for all third-party applications, select the application control policy at the upper application level.

For BlackBerry Enterprise Server 4.0

  1. On the BlackBerry Enterprise Server, open the BlackBerry Handheld Configuration Tool.
  2. In the left pane, click Software Configurations.
  3. Select a software configuration and click Edit Software Configuration.
  4. Click Add New Configuration.
  5. Type a name for the new configuration.
  6. (Optional) Type a description.
  7. In the Handheld Software Location field, click Change and browse to C:\Program Files\Common Files\Research In Motion folder. The location can also be typed in standard UNC format (for example, \\servername\sharename\path\filename) or navigate from Network Places.
    Note: For more detailed information on BlackBerry Device Software Configurations, see the appropriate BlackBerry Enterprise Server 4.0: Handheld Management Guide.
  8. Click Policies.
  9. Complete one of the following tasks:
    • To modify an existing application control policy, select it from the left pane and click Properties.
    • To create a new application control policy, click New and type the required information. For more information, see the BlackBerry Enterprise Server 4.0: Handheld Management Guide.
  10. Locate the label for Event Injection and change the setting to Allowed.
  11. Click OK on the Properties window and the Policies window.
  12. Expand the Application Software tree.
  13. Complete one of the following tasks:
    • To enable Event Injection for one third-party application, in the Policy column, select the appropriate application control policy from the drop-down list.
    • To enable Event Injection for all third-party applications, select the application control policy at the upper application level.
CollapseAdditional Information

While this article describes the process for allowing the Event Injection property, the steps described apply to all properties of an application control policy. For a list of the available properties, see the BlackBerry Enterprise Server Policy Reference Guide.

Disclaimer

By downloading, accessing or otherwise using the Knowledge Base documents you agree:

   (a) that the terms of use for the documents found at www.blackberry.com/legal/knowledgebase apply to your use or reference to these documents; and

   (b) not to copy, distribute, disclose or reproduce, in full or in part any of the documents without the express written consent of RIM.


Visit the BlackBerry Technical Solution Center at www.blackberry.com/btsc.