Skip to main content

Overview

How it works​

Every Template is associated to a unique useCaseTemplateId. Every component/system generated from it, will have that parameter saved in their catalog-info.yaml. By defining an EditTemplate, the platform team will link that template to already existing Templates entities using useCaseTemplateId, enabling users to edit entities generated from them.

Once the user inputs in the pickers the values to be edited, a merge operation happens in order to merge the old values with the new provided ones. At the end, a comparison page will show all the modifications made by the user and there will be the possibility to save those changes to git, using a user-friendly UI.

tip

The Editor Wizard section in the User Manual describes the witboost user journey.

Enable Editor Wizard​

In order to enabled the editor wizard for one or more entities, the platform team should:

  • define what are the editable parameters for a specific useCaseTemplateId (E.g. for a specific Template entity) by creating a new EditTemplate entity.

    note

    Check the Edit Template section.

  • optionally, define the editor wizard policy to be applied.

    note

    Check the Prefill Pickers Policies section.