Skip to content

[DX] GAP-21: bindings.json metadata.Connector must be the connector technical key, not the display name #1512

@AlexBizon

Description

@AlexBizon

Summary

The metadata.Connector field in a bindings.json connection binding must contain the connector's internal technical key (e.g. "uipath-salesforce-sfdc"), not its display name ("Salesforce"). Using a display name causes a hard deployment failure with a cryptic error. The technical key is not discoverable without calling the Integration Service API directly.

Error

When deploying to Orchestrator's Package Requirements screen:

Connector with key or id: [DataFabric], not found (#CNS1001)

Root Cause

Orchestrator uses metadata.Connector to look up the connector definition in Integration Service. The lookup is by connector key (an internal technical identifier), not by display name. There is no fallback or fuzzy match.

The technical key is only discoverable by calling the Integration Service connections API and reading connector.key from the response. There is no:

  • Mapping table in documentation
  • CLI command to list connector technical keys
  • Validation at uipath pack time

Example Correct Format

{
    "resource": "connection",
    "key": "6fba04c7-1d0e-4393-adec-705e858ff67a",
    "value": {
        "ConnectionId": { "defaultValue": "6fba04c7-..." }
    },
    "metadata": {
        "Connector": "uipath-salesforce-sfdc",      // technical key, NOT "Salesforce"
        "UseConnectionService": "True",
        "BindingsVersion": "2.2"
    }
}

How to Find the Technical Key

Call the Integration Service connections API and read connector.key:

GET /elements_/scaleunit_/.../ v3/element/connections

The connector.key value (e.g. uipath-salesforce-sfdc, uipath-uipath-dataservice) is what goes in metadata.Connector.

Suggested Fix

  1. Validate metadata.Connector at uipath pack time — warn if the value does not match the pattern of a technical key (e.g. kebab-case with vendor prefix)
  2. Or auto-populate it from the live Integration Service API when uipath init is run and connections are referenced
  3. At minimum: document the required format and where to find the technical key, with a table of common connectors

Impact

  • Severity: High
  • Hard deployment failure with a cryptic error; no indication from the error that a display name was used instead of a technical key

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions