Use Write companion metric to create or update a metric that can be linked to a business case. Configure one metric per step. To write multiple metrics from a table, place the step inside For each.
Example: Track planned and actual service adoption
Scenario: Business case uses adoption KPI to compare expected activity with observed outcome.
-
Create companion metric for clearly named KPI, such as Active service users, and choose Users as unit.
-
Set target and choose Planned with intended date to record expected value. For later observations, use Actual and matching date.
-
Store metric under
metric. Link metric to case in Write business case when needed. -
Test using sample dates and values. Verify that same metric name updates existing metric rather than adding duplicate, and check case link after write.
Configure the metric
-
Open Admin > AI Studio > Orchestrate > Automations and select an automation.
-
In Builder, select + Add step > Write companion metric.
-
Enter Metric name. An existing metric with the same name is updated; fields left empty retain their existing values.
-
Enter Category, if needed.
-
Set Target. Default shown is
0. -
Select Units, or select Use a variable for units not listed. Options shown include Count, GB (Traffic), GB (Storage), Employees, Users, Licenses, Percentage, Dollar, Credits, Requests, Days, Hours, Minutes, and Seconds.
-
Set Rate. Default shown is
1. -
Under Value, choose Planned or Actual, supply Date in
YYYY-MM-DDformat or an available date variable, and enter value as applicable. -
Set Store as variable, such as
metric, for later steps. -
Save and use Test run. Verify output in Run History before activation.
Write multiple metrics
To create one metric per row of a table, place Write companion metric inside For each and reference the current row, for example item.name, in supported fields.
Link to a business case
A business case can link only to a metric with at least one value. For new metrics, saving a target writes it as a Planned value for the business case's first month. The same metric, value type, and date combination updates its existing value when saved again.
When linking several metrics, pass the resulting metrics table to Write business case > Metrics. The Builder also exposes metric.label, metric.name, and metric.created to later steps.
Check before activation: Confirm metric name, value type, dates, units, and intended business case. Reusing an existing metric name updates that metric rather than creating a duplicate.