Tutorial | Get started with the Blueprint Designer#

Background#

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.

Diagram showing blueprint versions inside of a blueprint.

Some uses for custom blueprint versions include:

  • Adjusting item fields

  • Changing an item’s workflow

  • Adding Python code to automate actions

Note

You have the ability to create completely new blueprints if necessary for your use case. However, in most cases, it is appropriate to create custom blueprints from copies of our built-in templates.

Prerequisites#

To complete this tutorial, you will need:

  • A Dataiku Govern instance (version 12.0 and above).

    Note

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

  • An Advanced Dataiku Govern license.

  • Administrator privileges.

You should also be familiar with some technical specifications, available in our reference documentation on Blueprint Designer.

Create a blueprint#

If you would like to create a new item, you must add a new blueprint in the Blueprint Designer.

  1. From the Applications menu, select Blueprint Designer.

    Screenshot showing the Blueprint designer in the applications menu.

  2. Click the Create Blueprint button in the top right of the page.

  3. Write My Blueprint in the Name field. The ID field will be automatically populated.

  4. Click on the New icon and select any icon.

  5. Click on the color icon and select any color.

Filled in new blueprint dialog box.

  1. Select Save to create your blueprint.

Note

It is not likely that you will need to create a new blueprint in practice.

Customize a blueprint version#

Let’s say that we want to augment the template for the Govern model version blueprint. We can make a copy of the standard blueprint version and customize it to our liking.

Fork a blueprint version#

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

  2. Click Create New Version.

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

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

Filled in new blueprint version dialog box.

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.

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 tab and click on Model Version info.

  2. Under the list of View Components, you will see a tree of view components. On the Description view, click on the three dots which will open a menu of actions.

  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.

Screenshot of the model version information view with the owner field added.
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.

Dataiku screenshot highlighting the steps to add a conditional view to the Owner field.

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.

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

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.

Screenshot of the first sign-off configurations.

Continue to configure the sign-off:

  1. Select +Add New Feedback Group in the Feedback section.

  2. Type in Business reviewer in the Title field.

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

  4. Scroll down to the Final Approver section and select Final approver from the Select Roles dropdown menu.

  5. Since we don’t want to create a scheduled reset, skip this step. 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.