Skip to main content
Version: v12

Reviewing Connector Schema Changes

This article explains the Pending Changes review step that appears when you upgrade the connector version used by an existing data integration, and how to resolve attribute changes without disrupting your data consolidation configuration.

Why review schema changes?​

Connectors are updated regularly to add new attributes, fix issues, and keep up with changes in the source system's API. When you update a connector and select the new version in an existing data integration, the attributes it reports can differ from what your integration previously saved — attributes may be added, removed, renamed, or have their properties changed.

Some of these attributes may be referenced by your consolidation configuration — for example, as an identifier or as part of an attribute mapping. Before this review step existed, upgrading a connector could change or remove an attribute your consolidation rules depended on without any warning. The Pending Changes step surfaces exactly what changed and lets you decide how to handle each change before it takes effect.

When does Pending Changes appear?​

  1. Open an existing data integration for editing.
  2. On the connector configuration step, select a different Version for the connector, as described in Outdated connector version in the configuration.
  3. Click Next.

If the new connector version's schema differs from the schema your integration previously saved, a Pending Changes step appears in the wizard, marked with an alert badge until you open it. If nothing changed, this step is skipped entirely.

info

Only attribute-level changes are surfaced here — properties like retention settings or inactivity strategy are not part of this review.

Reviewing changes​

Opening the Pending Changes step shows a summary of what changed, with a card for each category that has at least one change:

  • Pending Review — changes you haven't addressed yet.
  • New Attributes — attributes reported by the new connector version that weren't there before.
  • Removed Attributes — attributes that no longer exist in the new schema.
  • Changed Attributes — attributes that still exist but have a different type, title, or mapping.
  • Renamed Attributes — an attribute that appears to be the same one, but under a new name (matched by attribute type and title).

Below the summary, a table lists every changed attribute with:

  • Source Attribute — the attribute's name; renamed attributes show their previous name as well.
  • Change — a badge (New / Removed / Changed / Renamed) with a tooltip describing what happened, for example "Renamed from oldAttributeName".
  • Used in Consolidation — whether this attribute is referenced by a consolidation configuration, so you can immediately see whether a change matters.
  • Status — Pending for review, Reviewed, or Ignored.

Use the filter tabs (All / New / Removed / Changed / Renamed) and the In use only toggle to narrow the list down — for example, to focus only on changed attributes that are actually used in consolidation.

Resolving an individual change​

Click Review on a row to expand its details panel:

  • What changed — a field-by-field comparison of the old and new values. When only the connector-to-data-model mapping changed, this shows as "Mappings updated."
  • Enable this attribute in Sync configuration — shown only for new or renamed attributes. Turning this on automatically checks that attribute in the sync configuration step, so you don't have to go find it there yourself.
  • Used in — the consolidated data model(s) this attribute participates in, tagged as Identifier and/or Consolidation Mapping. When Brinqa can resolve the data model, this links directly to its Consolidation page in a new tab.
  • A closing note appropriate to the change:
    • If the attribute is used in consolidation: "This attribute is currently used in consolidation. Removing or changing it may disrupt data consolidation."
    • If it's not used anywhere: "This attribute is not used in any consolidation definition. It is safe to proceed."
    • For removed attributes still in use: "This attribute will no longer be mapped during consolidation for this data model. It will not remove the attribute from the data model."

Click Mark as reviewed to confirm you've addressed the change.

caution

For renamed attributes, consolidation references that pointed to the previous name are not automatically updated — you may need to update them manually on the data model's Consolidation page.

Ignoring a change​

If a change doesn't need the detailed review panel, click Ignore directly from the table to mark it addressed. Both reviewed and ignored rows show a Review again action if you change your mind — this returns the attribute to Pending for review.

You can also select multiple rows (or use Select all in current view to select everything matching your current filter) and apply Mark reviewed or Mark ignored to the whole selection at once.

Saving your changes​

You can't save the data integration while any attribute is still Pending for review — the Create/Update button stays disabled with a "Review all pending schema changes before saving" tooltip until every change has been reviewed or ignored.

Last updated on