Skip Navigation

BlackBerry Dynamics
entitlement ID and version

BlackBerry Dynamics
apps are uniquely identified by a
BlackBerry Dynamics
entitlement ID (
GDApplicationID
) and entitlement version (
GDApplicationVersion
). The entitlement ID and entitlement version are used to manage end-user entitlement for your apps, as well as for publishing and service provider registration. The
BlackBerry Dynamics
entitlement ID was formerly known as the app ID or GD App ID.
The entitlement ID is used in the app, in the
BlackBerry UEM
or standalone
Good Control
management console for app management, and in some administrative user interfaces on the application developer portal.
The entitlement ID and entitlement version are different from the native application ID and native application version. The native application ID is a unique identifier for the app that is used by the OS and associated platforms (for example, the package name for
Android
or bundle identifier for
iOS
). The native application version is the app version number that you must change if you want to distribute a new version of an app. You only need to change the entitlement version if the app starts to provide a new shared service or shared service version, or if the app stops providing a shared service or shared service version. For more information about when to change the entitlement ID and entitlement version, see the BlackBerry Dynamics API reference.
Requirements for the entitlement ID and entitlement version
Requirement
Description
Required for apps
You must define both the entitlement ID and the entitlement version for all your
BlackBerry Dynamics
apps, regardless of whether you use the
BlackBerry Dynamics
Shared Services Framework. Developers and administrators should ensure that the value specified for the
GDApplicationVersion
key in the app configuration files is the same as the value the administrator specifies in
BlackBerry UEM
or in standalone
Good Control
.
The entitlement version is independent of any native version identifier. For more information, see Distinction from and use with native language identifiers.
Represent the same app across all platforms
The same entitlement ID must be used to represent the app across all platforms. By default, access to apps varies by the type of app:
  • By default, all versions of partner or ISV apps are available to all authorized users in any organization that the app has been published to.
  • By default, each version of a
    BlackBerry Dynamics
    app requires that the administrator grant access in
    BlackBerry UEM
    or in standalone
    Good Control
    before users can run the app on users' devices.
Naming scheme
Develop a naming scheme to meet your needs. For example:
  • Entitlement ID: com.manufacturingco.gd
  • Entitlement version: 1.0.0.0
  • Native application version: 2.0
Entitlement ID format
  • The general form of an entitlement ID is
    <company_name>.<app_name>
    .
  • The ID must use reverse domain name form, for example, com.company.example. Use a domain name owned by your organization.
  • The ID must not begin with com.blackberry, com.good, com.rim, or net.rim.
  • The ID can contain only lower-case letters, numeric digits, hyphens, and periods.
  • The string must follow the <subdomain> format defined in section 2.3.1 of RFC 1035, as amended by Section 2.1 of RFC RFC 1123.
Entitlement version value
  • The value must use one to four segments of digits, separate by periods (x.x.x.x).
  • Each segment can be up to three digits and must not use a leading zero (for example, 01.02 is not valid). A segment can use a single 0.
  • The first release of an app should use the entitlement version 1.0.0.0.