Tutorial | Blueprint Designer#

Get started#

Start using the Blueprint Designer by building and applying a new blueprint version.

Objectives#

In this tutorial, you will:

  • Fork and edit a Govern model version template.

  • Make changes to fields and views.

  • Customize a workflow and add a sign-off.

  • Apply your new blueprint version to an item.

  • Update your new blueprint with more complex views.

Prerequisites#

To reproduce the steps outlined in this tutorial, you will need:

  • Dataiku 14.0 or later.

  • An Advanced Dataiku Govern license.

  • A Full Designer user profile.

Customize a blueprint version#

If you want to do something like change the fields of a Govern item, you can create a custom blueprint version. In this section, you will copy and modify the blueprint version of a Govern model version.

Fork a blueprint version#

Usually you should fork (copy) an existing blueprint version and customize the copy.

  1. Open your Govern node.

  2. From the waffle (Waffle icon.) menu, select Blueprint Designer.

  3. In the left panel, select the Govern model version blueprint.

  4. Click Create New Version.

  5. Keep the default selection: Fork the system default. This will create a copy of the system default blueprint version.

  6. Name the blueprint version <YOUR_INITIALS> Tutorial Govern model version.

  7. Click Fork. This will create the new blueprint version and open the editor.

The Govern model version page in the Blueprint Designer.

Add a field#

Next, we’ll make some changes to the blueprint version.

  1. Navigate to the Fields panel on the left.

  2. To add a new field, click the plus button next to the search bar above the list of existing fields.

  3. Define the new field as a Reference.

  4. In the Field Name, type Owner. This will automatically generate a field ID, but you can define your own.

  5. Click Create.

Dataiku screenshot of the dialog to add a new field.

Let’s finish configuring the new field.

  1. Check the isList checkbox.

  2. Set the cardinality Min field to 0.

  3. Under the section Type: REFERENCE, leave the default selection Store.

  4. From the Allowed blueprints dropdown, select User.

  5. Click Save Draft.

Screenshot of field in owner field settings.

Configure views#

Now, we will configure some views that will organize our fields.

  1. Navigate to the Views panel.

  2. Click on Model Version info.

  3. On the Description view component, select the More Options menu.

  4. Select Insert view component > After selection.

Dataiku screenshot of the path for inserting a view component.

Next, finish adding the new view component.

  1. In the list of available fields, choose Owner by clicking the plus button. This will add it to the list of selected fields on the right.

  2. Click Create.

  3. Click Save Draft to finish adding the Owner field you previously created to the model version info view.

Customize the workflow#

Another thing you can do in the Blueprint Designer is change the workflow of an item.

  1. Return to the General panel.

  2. In the Workflow section, click Add Step.

  3. In the newly added step at the bottom of the workflow, type Validate in the Step name field.

  4. From the View dropdown, choose Review info.

  5. Drag this Validate step under the Review step.

  6. Click Save Draft.

Screenshot of the model version workflow with the added Validate step.

Add a sign-off process#

Next, let’s add a sign-off process to the new step in the workflow.

  1. In our Validate step, click Create Sign-off.

  2. For the Sign-off name field, type Validation Sign-off.

  3. For the Description field, type Validation review process.

  4. Under Validation Rule, keep the Make approval mandatory checkbox selected.

Screenshot of the first sign-off configurations.

Continue to configure the sign-off:

  1. In the Feedback section, select + Create Group.

  2. In the Title field, type Business reviewer.

  3. Enable the Roles checkbox.

  4. From the Select Roles dropdown menu, select Business reviewer.

  5. In the Final approver section, enable the Roles checkbox.

  6. From the Select Roles dropdown menu, select Final approver.

    Dataiku screenshot of a feedback group.

  7. Click Create at the top of the page.

Activate and apply your template#

Now, take a look at your changes. You can archive you blueprint version once you are done testing it.

Caution

Make sure that you want to activate your blueprint version globally on your instance before completing this section.

  1. Click the back arrow to return to your blueprint version.

  2. Click Save and Activate > Activate.

  3. Find a model version to govern on your instance or import this project into your Dataiku Design instance as a test project.

  4. Govern the model version, making sure to select your blueprint version as the template.

  5. Open your Govern model version.

  6. Notice that the workflow steps include your new validate step.

  7. You will also see your new owner field.

A Govern model version using the tutorial blueprint version.

Tip

If you’re unfamiliar with how to govern a model version, see Tutorial | Governance basics.

Advanced views in the Blueprint Designer#

If you want, you can try taking your views a few steps further in complexity. In this section, you will define and try out more granular settings in the Blueprint Designer.

Limit item selection#

Reference fields let users select existing items or create new items. With the Blueprint Designer, you can limit this action to only selecting or creating items.

  1. In the Blueprint Designer, re-open your custom blueprint version.

  2. Navigate to the Fields panel.

  3. To add a new field, click the plus button.

  4. Select Reference.

  5. For the Field Name, type Qualification Project.

  6. Click Create.

    The steps to create a reference field in the Blueprint Designer.

  7. In the Allowed blueprints dropdown, select Govern project.

Next, we’ll add this field to the same view that we worked with earlier in the tutorial.

  1. Navigate to the Views panel.

  2. From the available views, open Model version info.

  3. On the Owner view component, select More Options > Insert view component > After selection.

  4. In the list of available fields, choose Qualification Project by clicking the plus button.

  5. Click Create.

  6. In the Details panel of the Action Item component, find the Choose how the user can select items dropdown.

  7. Choose Only select existing items.

The steps to limit how a user can select items of a reference field.

Add a view condition#

Let’s also add a condition to the Action Item view component such that it only appears when the Description field is populated.

  1. In the Conditional view section of the Details panel, open the Visibility condition dropdown and select Description.

  2. From the Condition type dropdown, select Is not empty.

  3. Click Save.

  4. You will see a warning that tells you this change will affect an associated artifact. Take a moment to understand why, and then click Save.

Dataiku screenshot highlighting the steps to add a conditional view.

Review changes#

Once you have made your changes, you’ll want to view their effects on the Govern model version.

  1. Open the Govern model version that uses your custom blueprint version.

  2. Notice that there is no Qualification Project field on the Overview page. The Qualification Project field doesn’t appear yet because we added a view condition.

  3. Click Edit and add some text to the Description field. The Qualification Project field should then appear in the page.

  4. Click Select existing next to your Qualification Project field and choose a project.

A Govern model version using the updated tutorial blueprint version.

Next steps#

You just learned how to make a custom blueprint version in the Blueprint Designer. You can experiment with adding fields to different views to see where they appear in the applied template.

See also

If interested, take a look at importing templates in Tutorial | Use imported templates in the Blueprint Designer.