Extend Trimble Connect

This guide provides directions on how to build a Trimble Connect extension leveraging the Workspace API.

Develop and host a web application

You can choose a framework of your choice to build and host the application. After you create the application, you need to create the manifest file.

Create the manifest file

A manifest file contains crucial information about the extension like name, description, version, unique ID, etc. The manifest file also lists the APIs that the extension needs to access. The manifest file is usually stored in the server and has a unique URL.

After creating the manifest file, you need to register the extension in Trimble Connect.

Register an Extension

To register an extension in Trimble Connect using the manifest URL:

1. Open your project in Trimble Connect for Browser.
2. Select Settings in the left pane.
3. Select Extensions.
4. Enter the manifest URL in the Extension manifest URL field and select Add.
5. In the Custom Extensions section, enable the extension.

Note

Only project administrators will be able to enable the UWA Project Extension toggle.

Initialize the Workspace API

After registering the extension, you need to initialize the workspace API. When you initialize, a communication channel will be created between the extension and Trimble Connect. The extension will also create a function that defines the action that needs to be performed for each event Trimble Connect creates.

When the extension calls an API, Trimble Connect will respond by creating promises or events. Some API calls may not trigger an event. When the extension receives an event, the corresponding action will be carried out.

Handle the access token

If the extension wants to avail the services of products other than Trimble Connect, the extension will need an access token. Let’s assume that you want to access the list of projects handled by a Jobpac Connect user. Now, the extension will request Jobpac Connect to share an access token. When Jobpac Connect shares the access token, the extension will use it to retrieve the information it was looking for.

See Create an Extension for more information