CoPilot Licensing
Contents
Customers and integration partners wishing to deploy multiple copies of CoPilot navigation can do so through a number of different licensing methods.
Account Manager
(Requires CoPilot 10.14.0.325 or later. New Customers Only.)
Account Manager is a convenient way to activate and manage large numbers of CoPilot licenses—for both individual fleets running CoPilot and software companies integrating CoPilot with their own applications. Using our Account Manager web tool or APIs, you can assign licenses to specific assets—vehicles, devices or drivers—and then reassign them over time as devices or staffing change.
A license is assigned to an Asset ID, which could be a company issued device ID, driver ID, email address, phone number, device descriptor, or vehicle number—whatever works best for your implementation. That Asset ID and a unique Company ID assigned by Trimble Maps are then used to validate the license on a device using either:
- CoPilot’s URL Launch capabilities.
- Licensing APIs in our CPIK libraries.
Contact us if you’d like to learn more about purchasing multiple CoPilot licenses and taking advantage of Account Manager.
Product Key License (Standard)
With product key licensing, CoPilot features are managed by a 25-digit product key. The key unlocks the required elements, ensuring the correct map regions and features are available.
License keys can be activated automatically via the CoPilot application. Activation requires an Internet connection and some simple on-screen instructions. Alternatively, the device can be activated via manual activation.
Manual activation requires both the device and a PC Internet connection. The user will be required to connect to activate.trimblemaps.com. Once you are on the activation site, follow the steps provided to carry out a manual activation of a product key license.
This manual solution works well for single or a small number of deployments but becomes very cumbersome and error-prone if deploying a significant number of units.
Deactivation
A license key can only be used once. If during the development phase or through a device refresh you need CoPilot installed on a new device, it is possible to de-activate CoPilot on an existing device and re-use the license key on another device.
If you have uninstalled CoPilot from the device and forgotten to deactivate the product key please email and include the 25-digit product key to request a reset.
Enterprise Licensing
CoPilot enterprise licensing allows for an enterprise license key to be activated on multiple devices using the same CoPilot build. License management can be controlled via APIs. This reduces the level of work and risk of manual errors that prohibit a successful activation.
Please note that a specific enterprise version of CoPilot and specific CoPilot enterprise license keys are needed to ensure this functionality works. CoPilot standard license keys are restricted to only one activation.
Trimble Maps historically used different methods for enterprise license products but has moved to a streamlined Generic Enterprise version which offers activation via an API.
Build behavior
Following the release of CoPilot 10.9, both enterprise keys and generic keys can be used to activate CoPilot builds. Once CoPilot is launched you will always be presented with the product key entry screen. Once on this screen, a generic key can be entered into CoPilot through the UI to activate the application.
If integrating with CoPilot and activating through enterprise keys via API, following the CoPilot licensing ready callbacks the API call to activate CoPilot should be passed.
Note: 1. Generic keys can be entered manually into the CoPilot UI or entered through API 2. Generic Enterprise keys can only be activated via API and cannot be entered via the UI screen
Contractual Agreement and License Reporting
Before any enterprise license versions can be delivered, even for evaluation, we require a contractual agreement to be in place.
Any version of CoPilot deployed under an enterprise license is to be reported to Trimble Maps in accordance with the terms of the agreement, as we are not in control of licenses installed with an enterprise key.
CoPilot Generic Enterprise Version
CoPilot 10.9
If you are using CoPilot 10.9, Enterprise keys and standard keys can be used on the same build. If you are using a build that was released prior to 10.9 please see the information below.
CoPilot versions 10.4 and earlier
The Generic Enterprise version is a separate CoPilot build to the standard product key release, as it allows the same product key to be activated multiple times on different devices.
Upon first launch, the integrating application will check the license key status. It may return that the product is inactive if the product has not been activated before with an enterprise key. At this point, the integrating application is required to pass the 25-digit enterprise product key that will activate CoPilot. Multiple enterprise product keys may be provided to activate different attributes. This approach allows our partners to create different configurations depending upon their end-customer requirements.
Most partners will receive multiple license keys to activate on each device. For instance, the base enterprise product key will allow car routing with a single country map region. The additional enterprise product keys may activate a larger map region (such as all of Europe), truck-specific routing or ActiveTraffic.
About Generic Enterprise Keys
- We recommends a restart of the CoPilot application once all product keys have been activated, to ensure everything works as required.
- The enterprise product keys provided will be unique to the customer or integration partner’s deployment requirements. This may mean more than one key is required.
- The Generic Enterprise CoPilot version allows for multiple release versions and feature attributions to be used without changing the CoPilot version and only differentiating the requirements with an API activating the product keys.
- The standard CoPilot build (product key activation) and the Generic Enterprise version will have different version numbers. Please note that standard product keys cannot be used to activate a license in a Generic Enterprise build or vice versa.
APIs to be Used for Licensing
Enterprise Licensing – Activation
The CoPilot Generic Enterprise version does not need an Internet connection. If CoPilot detects the device has an Internet connection, it will attempt to contact the Trimble Maps Activation servers (licensews.alk.com). If the device does not have a connection, the activation will complete offline.
When transitioning from a Product Key License version of CoPilot to a Generic Enterprise version, the user may be presented with the error “-754”. This error is received because CoPilot does not hold a license key. Users are required to pass in an Enterprise license key via the licensing API.
Bundle ID Information
Different bundle IDs are present across CoPilot deployments. This bundle ID is used by the system as a domain for which it can store settings and reference CoPilot.
The standalone version of CoPilot currently has a bundle ID of “com.alk.copilot”. All standalone versions of CoPilot require the input of a product key to enable the functionality.
Generic Enterprise deployments of Android CoPilot versions 966 and above will have the bundle ID “com.alk.copilot”. This enables more seamless movement from product key standalone deployments of CoPilot to Generic Enterprise versions. In all CoPilot versions prior to version 966, Generic Enterprise deployments will have the bundle ID “com.alk.copilot.generic.enterprise”.
All other OS will maintain the “com.alk.copilot.generic.enterprise” bundle ID.
When CoPilot CPIK libraries builds are deployed, they receive a specific Bundle ID relevant to the specific partner, build or deployment. This is also applicable to custom enterprise builds where in some scenarios it is possible to have a custom bundle ID created.
Over the Air (OTA) Map Download
CoPilot supports the download of map data over the air via a mobile Internet connection or Wi-Fi. This can be carried out on first install or subsequently via a specific request made to download updated map data. The map data available to download is linked to the license that has been enabled on the device.
When a license has been activated on CoPilot, API calls can be made to request the download of map data. Full details on the API calls required can be found within the respective (SDK or CPIK libraries) integration’s API documentation.
A number of checks are performed before the download of data can be completed. On the first installation of CoPilot, a check to see if any data is currently present will take place. If the licensed map data cannot be found, the process will be initiated to request the download of map data.
The integration request can be made by using specific APIs that can dictate whether the download will take place over mobile Internet or Wi-Fi. Once the download has completed, CoPilot will fully integrate the data and allow use of the application.
The status of the download can be returned at any time by using the status call APIs. These will inform the integration application if the download has been started, cancelled or paused. A number of return codes are also available following the API request. Full details of these can be found within the respective integration’s API documentation.
For further information on utilizing OTA map downloads, please speak to your Trimble Maps account manager or sales engineer. They will be able to provide full details on the license requirements needed within your deployment.