Properties

Properties are key-value pairs that can be used to add additional information to your experiments and runs. They can be used to store metadata about the experiment, such as the experiment's purpose, the team responsible for it, the outcome, or just a note of a specific run or any other relevant information.

In general, a user can only assign properties to an experiment design or run that have been defined by an administrator. Once you - or your administrator - has assigned the property, you can capture values per experiment design or experiment run.

Examples

• Adding a note to a single experiment run

  • Your administrator has defined a property definition called note with the datatype rich text.

  • You can add the property note to a single experiment run, you are allowed to edit, and fill out a Markdown value like "This experiment was really great!".

• Adding a mandatory cost center field to each experiment

  • Your administrator has defined a property definition called costCenter with the datatype integer.

  • Your administrator has assigned the property definition costCenter to all experiment designs and marks it as required.

  • You need to fill out the cost center for each experiment you want to run.

Assign Properties

Properties that are defined by your administrator, can be assigned to a single experiment design or run by any team member. This way, you can add additional context to your experiments, in the experiment design or for a specific run. Properties assigned to an experiment design or an experiment run can be removed later on. Properties copied from the experiment design to a run cannot be removed later.

A property assignment configuration consists of the following fields:

• Property Definition Key: The referenced property definition assigned to the experiment design or run.

• Mandatory: A checkbox indicating whether a value is required or not. If checked, the property must be filled in before the experiment can be run.

• Allow editing the value in the experiment run: A checkbox indicating whether the property can be edited at run-level. If checked, the property can be edited in the run details page.

API

Properties can also be assigned using the following API endpoints. Check out Integrate with Steadybit / API how to access the API.

• Assign properties to an experiment design

• Assign properties to an experiment run

Property Values

Property values are the actual values of the properties that are saved as part of an experiment design and copied to each experiment run. Variables are fully supported for the input fields of all properties. (including overrides for single runs or via schedules).

API

Properties' values can also be read and edited using the following API endpoints. Check out Integrate with Steadybit / API how to access the API.

• Update the properties of an experiment design

• Get the properties of an experiment run

• Update properties of an experiment run after it has completed