Skip to main content
Preview Releasing is the step that changes what agents read. A saved revision is private to Studio until you release it, and a released version stays the same when newer revisions are saved. This guide shows you how to release a revision, check what changes and who it reaches before you confirm, and verify the result.

​
Before you begin

Before you start, make sure you have:
  • Access: Access to Metrics Studio and permission to release metrics in the workspace.
  • Saved revision: The revision you want to ship. See Write metrics.
  • Metric app: An administrator has installed the Metric app in your account.
Releasing distributes a revision. It does not check the SQL or certify the number, so review the definition first.
1

Open release dialog

Open the metric and choose Release revision N. Right after you save a change, Studio can open the dialog itself with “Release this revision? Your changes are saved as a new revision. Nothing is released yet.”The button is unavailable while the release history cannot be loaded (“Release history could not be loaded. Retry before an action that can change distribution.”) and while the revision’s definition is still loading or failed to load. Choose Retry if it failed.
2

Check what ships and who gets it

The dialog tells you, before you confirm:
  • Which version: “Revision becomes version .” The first release says “It is the first release.” A later one says “It replaces , which stays readable by its number.”
  • What ships: the formula, or a comparison with the live release. The comparison says whether nothing differs, whether only the wording changed (“The calculation is the same, so the numbers do not change. Only the wording does, and agents read it.”), or whether “The calculation changes, so the numbers can change.”
  • Who gets it: “Agents and tools get this revision once it is released.”, or for another channel, those that read that channel. It lists what depends on the metric: metrics that use it in their SQL are reached by a change to the calculation, metrics that only list it are not, and a metric built from this one keeps its own copy of the SQL. Choose Inspect dependencies to see the links.
Studio lists only recorded links, so an empty list does not prove nothing uses the metric.
3

Release revision

Optionally open Add release notes and write Release notes (optional), up to 4,000 characters. They are saved with the release and shown in History.To release an earlier revision, or to release on another channel, open More options: release an earlier revision, or on another channel. Version to release lists the active revisions that have not already shipped on the channel. Release channel defaults to latest. It is free text, so use a channel your Registry is configured for.Choose Release revision N as . Studio shows “Released.” and a receipt, “Confirmed action receipt”, that re-reads the channel, for example ” currently resolves to revision .” A release can show as pending: the Registry’s checks run first, and agents do not get a pending release yet.
A revision cannot be released again on a channel where it already shipped, even after withdrawal. The dialog says “This revision has already been released on this channel. Choose another revision or channel.”
4

Verify release

Choose View release in the receipt, or open History and choose the version tagged Live. Confirm the version label, the channel, and that the formula is the one you meant. Reload the catalog and check that Release shows Live with your version.
5

Clear Registry hold (optional)

If the catalog shows Pending review or Blocked, the Registry is holding the newest revision. Open More actions and choose Clear the Registry hold. It clears the hold on the newest revision so it can be used. It does not check the SQL or certify the number, and it releases nothing, so release the revision afterwards.
If a write is not confirmed (“The server has not confirmed the result. Close this dialog and refresh the item before attempting another write.”), the dialog locks to Close only. Refresh the metric and read its History before you try again. If a dialog says “This item changed after you opened it.”, close it, refresh, and review the current version first.

​
Next steps

​
See also