Using Connections

When a user creates a new connection, that connection is now connected. That means the connection is successfully tested and available for use on any valid connector registration to which you have access.

A connection that is connected does not need to be tested for each workspace.

A connection is owned by the user who creates it. That means the connection is usable in all workspaces owned by that user's account.

Permissions are limited if a user does not own a connection, because they often include and are analogous to a username and password. Connecting with another users connection would be equivalent to logging in as someone else.

Other users on that account can view the connection but cannot edit it or view private fields like credentials (as defined by the associated connector), as well as test or disconnect. Before trying to connect, make sure you own the connection.

If the connection employs an authentication method with an OAuth grant type or flow, it must incorporate an OAuth client. An OAuth client is owned by the user who created it and is available to that user's account and to the connection for which it is prepared. For more information, see OAuth Clients.

A user who is an integration provider (typically with an App Xchange for Products license) may create a new connection to be used by a workspace deployed on behalf of another account. For example, when a user buys a pre-built App Xchange integration on the Trimble Marketplace, the integration provider typically deploys a managed workspace on behalf of that user. The integration provider also typically prepares a new connection for them to use in that workspace.

In this scenario, the integration provider owns the new connection. It is available for both the provider's account and the integration customer's managed workspace. The integration customer may also create their own connection for use by their account, including any workspaces managed by the integration provider.

Managing Connections

You can manage your connections by selecting it from the Connectivity page or the Connectors tab within a workspace.

To manage a connection being used on your workspace, select the connection name.

When viewing a connection from within a workspace, the Connection Details panel displays.

The preferences (gear) icon on this view includes options to Change Connection or Remove Connection from the integrations in the workspace.

Select Manage to display the connection details in your account.

The Connection page displays the connection name, the connector it enables, and its connection details. Connection details may include properties like the URL of an API or the type of authentication employed by the connector. Private fields such as API keys or user passwords are only viewable and editable by the user who owns or initially prepared the connection. The sidebar displays connection activity and usage details, including the workspaces and accounts that use the connection.

You can connect, disconnect, or test the connection from the connection details page. Testing the connection leverages whatever method the connector builder chose to confirm its authentication credentials. Disconnecting a connection deactivates it for all the workspaces in the right pane using that connection. Selecting Connect connects it to all the workspaces listed in the right pane using the connection.