Tutorial | Get started with the Blueprint Designer

In Dataiku Govern, items are built and organized using a standard template by default. However, you may want to tailor fields and workflows to specific use cases, needs, and requirements.

To do so, you’ll have to utilize the Blueprint Designer. The Blueprint Designer allows admin users to create new items, as well as new templates for items such as business initiatives, projects, bundles, models, and model versions.

Blueprints are containers that are associated with an item. Each blueprint comprises templates that determine how information is organized for that item. These templates are called blueprint versions.

Some uses for custom blueprint versions include:

• Adjusting item fields

• Changing an item’s workflow

• Adding Python code to automate actions

Get started

Objectives

In this tutorial, you will:

• Create a new 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.

Prerequisites

To complete this tutorial, you will need:

• Advanced Dataiku Govern 12.0 or newer.

• Administrator privileges.

• Familiarity with some technical specifications, available in our reference documentation on Blueprint Designer.

Note

This tutorial is not compatible with Dataiku Cloud at this moment.

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 most cases, you should fork (copy) an existing blueprint version and customize the copy.

In this section, you will copy and modify the blueprint version of a Govern model version.

Fork a blueprint version

1. From the Applications menu, select Blueprint Designer.

2. In the left sidebar in the Blueprint Designer, select the Govern model version blueprint.

3. Click Create New Version.

   

4. Keep the default selection: Fork the system default Blueprint Version (recommended). This will create a copy of the system default blueprint version.

5. Name the blueprint version <YOUR_INITIALS> Tutorial Govern model version and click Fork. This will create the new blueprint version and open the editor.

Add a field

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

1. Navigate to the Fields tab on the left.

2. Click the plus button next to the search bar above the list of existing fields.

3. Select Reference and type Owner in the Field Name. This will automatically generate a field ID, but you can define your own.

4. Click Create.

5. Check the isList checkbox and set the cardinality Min field to 0.

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

7. Select User from the Allowed blueprints dropdown.

8. Click Save Draft.

Configure views

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

1. Navigate to the Views tab and click on Model Version info. Here, you will see a tree of view components.

2. On the Description view, select the More Options menu.

3. Select Insert view component after, which will open a popup to create a new view component.

4. 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. You can also drag and drop to your selected fields.

5. Click Create.

6. Click Save Draft.

Optional: Add a conditional view

Let’s add a conditional view that will only be displayed when some predefined logic is satisfied.

1. Open the Details panel for the Owner view. Note that it may already be open.

2. In the Conditional view section, open the Visibility condition dropdown and select Description.

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

4. Click Save Draft.

Create a custom workflow and sign-off

Customize the workflow

Let’s first make changes to our workflow settings.

1. Return to the General tab.

2. Scroll down to the Workflow section and click Add Step.

3. Type Validate in the Step name field and choose Review info from the Views dropdown.

4. Drag this Validate step and place it under the Review step.

5. Click Save Draft.

Add a sign-off process

Next, we will add a sign-off process to our new step.

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

2. Type Validation Sign-off in the Sign-off name field and type Validation review process in the Description field.

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

Continue to configure the sign-off:

1. Select +Create Group in the Feedback section.

2. Type in Business reviewer in the Title field.

3. Enable the Roles checkbox.

4. Select Business reviewer from the Select Roles dropdown menu.

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

6. Select Final approver from the Select Roles dropdown menu.

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. Select 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. (If you added a conditional view to your blueprint version, fill in the Description field to see the Owner field appear in the view.)

What’s next?

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