How Clients Are Reconciled¶
The filters of a client must always match the criteria of its client type in the template active in each environment. BizMetry brings them in line when an environment is assigned another template version in the Release Pipeline.
When It Runs¶
Reconciliation runs when you save a change of template version for an environment, and the new version is PUBLISHED. It works only on that environment: filters of the same clients in other environments don't change.
If the version assigned isn't published, the client criteria step is skipped until the environment moves to a published version.
Editing a client type in a template, or the API collection events that modify one, don't change any client by themselves. They take effect at this point.
What Happens to Each Client¶
| Change in the new version | Effect on the clients of that type |
|---|---|
| A criterion or name was removed | Its filter is removed from the client in that environment, with its values, including filters that were toggled off. |
| A criterion or name was added | The client is not changed. The new criterion appears in the client, off and with no values. |
| The type was renamed | Clients take the new name. |
| The type no longer exists in the version, but another environment still offers it | Clients are detached from this environment. |
| The type no longer exists in the version, and no environment offers it | Clients of that type are deleted. |
| Only the operations behind a name changed | The client is not changed: its filter depends on the field or parameter name. |
Clients Requiring Attention¶
If a client enabled in that environment ends up with no active filter, it can no longer be identified there. BizMetry flags it:
While flagged, it can't be enabled from its row. Edit the client, give it filter values in that environment and save: the flag and its message clear. See Clients Requiring Attention.
From a Swagger Change to the Client¶
For example, agent_id is removed from the Swagger of a draft collection:
| Stage | Template version | Client in the environment |
|---|---|---|
| The Swagger changes | The draft version loses agent_id | No change: the environment runs a published version |
| The draft is published | The new version has no agent_id | No change |
| The version is assigned to the environment | Active in the environment | The agent_id filter and its values are removed; flagged if no active filter is left |
Going back doesn't restore values
Assigning the previous version again brings the criterion back, but not the values removed from the clients. They have to be entered again.