added

Custom Step Descriptions and Notes (v2.11.9+)

about a month ago by Shannon Lu

Add Custom Step Descriptions

Add your own description for steps while recording or editing journeys in the mabl Trainer. Sometimes the auto-generated step description from mabl doesn't quite capture the details or context of what you're trying to accomplish with your journey. Your custom step descriptions will appear in the place of mabl's auto-generated step description (shown below) and any notes you add to a step will appear in the Journey Details page and the Journey Output page (shown at the bottom).

Change long or non-descriptive step names (Left) to step descriptions that are more meaningful (Right).

Change long or non-descriptive step names (Left) to step descriptions that are more meaningful (Right).

Click the Annotate action to add a step description or step note. The icon will show a + if a step does not have any annotations.

The icon will show a `+` if a step does not have any annotations.

The icon will show a + if a step does not have any annotations.

If you delete your own description from the step, mabl will default to the auto-generated step description. Use the undo and redo actions as usual!

Add Step Notes for Additional Context or Details

Need to give your step some more context? Or maybe an explanation for teammates who may need to update the step in the future? Add a note to the step for additional information!

I promise I have a good reason...

I promise I have a good reason...

Step Descriptions and Notes in the Web App

Back in the mabl web app, you can see your custom step descriptions and step notes in the Journey Details page. Steps with your custom descriptions will also show an info icon with mabl's auto-generated description. Steps with additional notes will have the notes displayed beneath the step description.

Steps with your custom descriptions will also show an info icon with mabl's auto-generated description.

Steps with your custom descriptions will also show an info icon with mabl's auto-generated description.

Steps with your notes will have the notes displayed beneath the step description.

Steps with your notes will have the notes displayed beneath the step description.

While looking at your passing or failing journey, you'll also see your custom descriptions and notes in your journey run output as well!