Skip to content

Configure an External Project Provider

Configure the upstream URL and encrypted API token used by project synchronization, then test the saved connection in the portal. This procedure covers only connection setup; importing projects and managing synchronization are separate tasks.

  • A SENSE System Admin account (SYSTEM_ADMIN).
  • A configured Credential Store showing Store Active, with the expected keys loaded and no unresolved verification warnings.
  • The intended upstream provider’s base URL and a valid API token issued for that provider.

Provider settings, including the URL binding, are stored as projectsync.* global properties, while the token is encrypted in the Credential Store. Configure them together through this panel: creating a token in the generic Credentials panel alone does not establish its binding to the provider URL.

  1. Sign in to the portal and open Admin Settings → External Project Provider.
  2. Enter the intended Base URL, beginning with http:// or https://.
  3. Enter the API token in Token Status. The field is write-only; it does not display the stored token.
  4. Select Save. Confirm the settings-saved notification and that Token Status shows set. The input clears after a successful save; the badge and updated timestamp describe the stored token.
  5. Select Test Connection after saving. The test uses the saved URL and token, so unsaved input does not affect it.

Automatic sync and Sync Interval (in minutes) control scheduled synchronization separately. Leave those controls unchanged while validating the connection unless you intend to change that behavior. A connection test fetches and checks an upstream response; it does not import projects or run a synchronization.

  • To replace a token, enter its replacement in Token Status and select Save. In the inspected local implementation, only the original creator can replace or delete an existing token. A rejected operation leaves the provider settings unchanged, including a URL change that would clear another creator’s token.
  • To retain a token while saving other settings, leave Token Status empty. This preserves the existing token when the base URL is unchanged.
  • To change provider destinations, enter the new Base URL and its replacement token together, then select Save. Saving a changed URL without a replacement clears the stored token. The backend compares URLs after trimming outer whitespace and trailing slashes.
  • To remove the token, select Clear token and confirm Clear. This removes the stored token and its URL binding; it does not revoke the token at its issuing system. In the inspected local implementation, this also requires the original creator.

After Save, confirm the intended Base URL and Token Status: set, then inspect the result of Test Connection. A successful result is Connection Test: Fetched, with HTTP Status and Upstream Projects showing the upstream response status and parsed project count. This verifies the saved connection and response at test time; it does not establish that a synchronization has completed.

SignalCheck or action
Token Status input or Clear token is disabledCheck the displayed store-unavailable reason and restore Credential Store readiness.
Test Connection is disabledSave a base URL and token first. The button requires both to be present.
NotConfiguredCheck the saved URL and token. If a token was created outside the provider panel or lacks the current URL binding, enter it through this panel and save.
CredentialRejectedThe upstream rejected the token with HTTP 401 or 403. Check the token with its issuing system and replace it as appropriate.
CredentialUndecryptable or StoreUnavailableRestore the matching keys or resolve the reported store issue before retrying.
FetchFailed or SnapshotRejectedRead the displayed detail. The upstream request failed or its response was not an accepted project snapshot; a set token badge alone does not prove connectivity or response compatibility.
Replacement, clearing, or a URL change is refused because another user owns the tokenAsk its original creator to update it. In the inspected local implementation, System Admin access alone does not authorize replacing or deleting another creator’s token.

The fetcher refuses to send a token whose recorded URL binding does not match the saved provider URL. Token controls are disabled while the store is unavailable, and changing a URL may also fail if clearing its existing token requires an unavailable store.