How to set up Custom Formula Metrics?
Custom formula metrics allow you to populate custom fields of the entities in your system within values calculated according to formula expressions. Effort metrics help to customize the way that effort values are calculated in Targetprocess.
Requires Targetprocess 3.10.9+. Recalculations for existing data are available when Targetprocess is hosted in the cloud only.
Besides Custom Formula Metrics there are a few other features in Targetprocess that support custom calculations. More information: Custom Calculations and Formula Expressions
Targetprocess Administrators can create, modify, and delete metrics in their accounts. The metrics configuration page is available at Settings → Metrics.
Clicking the green "Add" button will display a list of different metric kinds available for customization. Just like with the Metrics feature itself, some metrics kinds are still treated as experimental, and so they might not be available for your account yet.
Currently, we support the following metric kinds:
- Custom formula metric. This one is somewhat similar to Calculated Custom Fields — it allows you to assign a calculation formula to some custom field.
- Effort/progress via relations metric. It allows you to calculate efforts and progress of Targetprocess entities from their relations. For example, you can make Requests have their progress calculated automatically from the Bugs or User Stories attached to them.
Choosing a metric kind or clicking the existing metric will take you to the metric details page, where you can change the metric configuration.
Each metric lets you specify its name and description (used to distinguish metrics in the list and maybe tell your colleagues about the metric's purpose), a list of processes it is enabled for, and a list of entity types it's applied to. Also, each metric has its own "custom" settings, which depend on the metric kind. For example, "custom formula" metric lets you define the calculation formula, while "effort via relations" allows you to choose which relation types should affect the entity progress.
Configuring custom formula metrics
Custom formulas support the same syntax as Calculated Custom Fields.
You may use Custom Field name for calculations by it's value. Spaces should be removed in Custom Field name, e.g. "Estimated Cost" should be represented in formula as EstimatedCost.
Custom Formula Metrics have been designed and released as a replacement for Calculated Custom Fields feature. We recommend prefer Metrics over Calculated Custom Fields whenever possible. More information is in our Developers Guide: Metrics vs CCFs
Before you add a new metric, preview its results on your entities. Use + Preview metric results link for this purpose. The link is displayed in the bottom of the 'Metric Setup' page. Once you checked that the metric produces expected results for selected entities, don't hesitate to save it and launch recalculations for all your data scope.
Use Metrics carefully. Metrics that set values to non-system custom fields can suddenly rewrite data in the fields. As a result manual user input may be lost. Also some metrics with poor design can slowdown your whole system or make it unstable.
Please avoid recalculation of 2 and more metrics performed simultaneously. Recalculate metrics one by one. Manually launch recalculation of a next metric only when recalculation of previous one is 100% complete.
Still have a question?
We're here to help! Just contact our friendly support team