Sorry about the red box, but we really need you to update your browser. Read this excellent article if you're wondering why we are no longer supporting this browser version. Go to Browse Happy for browser suggestions and how to update.

Configuring the push client

Prerequisites: Installing the sample push-enabled application on a device

  • Verify that the BlackBerry device that you want to install the sample push-enabled application on is synchronized with the BlackBerry Desktop Manager on the computer that you are using.
  • Verify that the device that you want to install the sample push-enabled application on has the service books for the BlackBerry Internet Service installed.
  • If you plan to install the sample push-enabled application from a computer that is not the computer where you installed the Push Service SDK , copy the .cod and .alx files for the sample push-enabled application to the computer that you are using.
  • Add a storage record for the sample push-enabled application to the system memory.

Add a storage record for the sample push-enabled application to the system memory

Before you begin:

Start Apache Tomcat by navigating to the bin folder in the Apache Tomcat installation folder and double-clicking either startup.bat or startup.sh.

Before you can send a push request message to the sample push-enabled application using the sample Push Initiator or the DebugPortal helper application, a storage record containing the attributes of the sample push-enabled application must exist in the system memory. The sample Push Initiator and the DebugPortal need to access this record. You can load the sample Push Initiator to automatically create the storage record in the system memory. The storage record contains the values that you typed for the push-enabled application when you installed the SDK.

  1. In the address field of a browser, type https://localhost:8443/sample-push-initiator.
  2. Press Enter. The web interface of the sample Push Initiator appears in the browser.

Install the sample push-enabled application on a device

There are no samples available for BlackBerry devices running a version of the BlackBerry Device Software earlier than 4.2.

When you install a sample push-enabled application on a device, you must choose the sample that is compatible with the version of the BlackBerry Device Software that is running on the device. You can find the .alx and .cod files of the samples in the folder for the sample push-enabled application, at the location where you installed the Push Service SDK.

Before you begin:

You need a computer with any version of BlackBerry Desktop Manager 4.6 to 5.0.1 to complete this task.

  1. Connect a device to a computer by using a USB cable.
  2. Start the BlackBerry Desktop Manager.
  3. If the device requires a password, specify the password and click OK.
  4. In the BlackBerry Desktop Manager, click Application Loader.
  5. In the Add/Remove Applications section, click Start.
  6. Click Browse.
  7. Navigate to the sample-push-enabled-app folder and perform one of the following actions:
    • If your device runs BlackBerry Device Software 5.0 or later, double-click the SamplePushEnabledApp5_0.alx file.
    • If your device runs BlackBerry Device Software 4.6 or later but earlier than 5.0, double-click the SamplePushEnabledApp4_6.alx file.
    • If your device runs BlackBerry Device Software 4.2 or later but earlier than 4.6, double-click the SamplePushEnabledApp4_2.alx file.
  8. Select the Sample Push Enabled Application check box. Click Next to complete the installation.

Configure the sample push-enabled application

Before you begin: Install the sample push-enabled application on a BlackBerry device.
  1. On the Home screen of the device that you installed the sample push-enabled application on, click Sample Push Enabled Application.
  2. Press the Menu key.
  3. Click Settings.
  4. Specify the configuration settings for the sample push-enabled application according to your Push Service SDK installation.
  5. Press Back and save the changes.
  6. Press the Menu key.
  7. Click Register.
  8. Type a user name and password of your choice. Click OK. After a short delay to complete the registration process, the message "Request to register executed successfully" appears.

    Remember the user name that you specify in this step. You need to use it as an address when you submit a push request message using the DebugPortal helper application.

Configuration settings for the sample push-enabled application

Setting

Description

Port

  • Specifies the port number on the BlackBerry device where content is received
  • The value is contained in the confirmation email that you receive after you register for the Push Service.

    This port number is the same as the port number that you specify when you configure the sample Push Initiator using the Push Service SDK setup application.

App ID

  • Specifies the application ID for the push-enabled application
  • The value is contained in the confirmation email that you receive after you register for the Push Service.

    This ID is the same as the sample push-enabled application ID that you specify when you configure the sample Push Initiator using the Push Service SDK setup application.

BPS server URL

  • Specifies an HTTP version of the PPG base URL that you receive after you register the push-enabled application with RIM (for example, if you receive a PPG base URL of https://pushapi.eval.blackberry.com, the BPS server URL is http://pushapi.eval.blackberry.com).

Push Initiator application URL

  • Specifies the URL for the server-side application (the sample Push Initiator or the DebugPortal helper application) that receives the subscription request from the device. For example, specify https://<push_server_host_name>:8443/sample-push-initiator to receive subscription requests with the sample Push Initiator, or https://<push_server_host_name>:8443/debug-portal to receive subscription requests with the DebugPortal, where push_server_host_name is the host name of the computer that hosts the sample Push Initiator or the DebugPortal.

    The URL must be accessible from the Internet.

App Acknowledgement

  • Specifies whether the push-enabled application supports application-level reliability
  • This setting must match the setting that you specify when you configure the sample Push Initiator using the Push Service SDK setup application.

    When you use the setup application to configure the sample Push Initiator, the default value set by the setup application does not configure the sample Push Initiator to use application-level reliability.