Tutorial | Use imported templates in the Blueprint Designer#

The Blueprint Designer allows Admin users to create new templates (or blueprint versions) for Govern items. This tutorial explains how to import, activate, and apply such templates.

Get started#

Objectives#

In this tutorial, you will:

  • Import a blueprint version.

  • Test migration import settings.

  • Switch a Govern project from the standard template to the new template.

Prerequisites#

  • A Dataiku Govern Advanced instance version 12.6 or later.

  • Admin artifact permissions.

Import a blueprint version#

Let’s begin by importing a new blueprint version.

  1. From the Applications menu, open the Blueprint Designer.

  2. Select Govern project from the blueprints menu.

  3. Next to the Create New Version button, click on the More options menu.

  4. Select Import new version.

  5. Copy and paste this script into the JSON content field using the Copy to clipboard button:

    {
    "dssVersion": 13000,
    "entity": {
        "blueprintVersion": {
            "id": {
                "blueprintId": "bp.system.govern_project",
                "versionId": "bv._academy_project"
            },
            "name": "Academy Project ",
            "fieldDefinitions": {
                "risk": {
                    "label": "Risk",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "value": {
                    "label": "Value",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "sponsors": {
                    "allowedBlueprints": [
                        "bp.system.user",
                        "bp.system.group"
                    ],
                    "label": "Sponsors",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "countries": {
                    "categories": [
                        "Global",
                        "Afghanistan",
                        "Albania",
                        "Algeria",
                        "Andorra",
                        "Angola",
                        "Antigua and Barbuda",
                        "Argentina",
                        "Armenia",
                        "Australia",
                        "Austria",
                        "Azerbaijan",
                        "Bahamas",
                        "Bahrain",
                        "Bangladesh",
                        "Barbados",
                        "Belarus",
                        "Belgium",
                        "Belize",
                        "Benin",
                        "Bhutan",
                        "Bolivia (Plurinational State of)",
                        "Bosnia and Herzegovina",
                        "Botswana",
                        "Brazil",
                        "Brunei Darussalam",
                        "Bulgaria",
                        "Burkina Faso",
                        "Burundi",
                        "Cabo Verde",
                        "Cambodia",
                        "Cameroon",
                        "Canada",
                        "Central African Republic",
                        "Chad",
                        "Chile",
                        "China",
                        "Colombia",
                        "Comoros",
                        "Congo",
                        "Costa Rica",
                        "Côte D'Ivoire",
                        "Croatia",
                        "Cuba",
                        "Cyprus",
                        "Czech Republic",
                        "Democratic People's Republic of Korea",
                        "Democratic Republic of the Congo",
                        "Denmark",
                        "Djibouti",
                        "Dominica",
                        "Dominican Republic",
                        "Ecuador",
                        "Egypt",
                        "El Salvador",
                        "Equatorial Guinea",
                        "Eritrea",
                        "Estonia",
                        "Eswatini",
                        "Ethiopia",
                        "Fiji",
                        "Finland",
                        "France",
                        "Gabon",
                        "Gambia (Republic of The)",
                        "Georgia",
                        "Germany",
                        "Ghana",
                        "Greece",
                        "Grenada",
                        "Guatemala",
                        "Guinea",
                        "Guinea Bissau",
                        "Guyana",
                        "Haiti",
                        "Honduras",
                        "Hungary",
                        "Iceland",
                        "India",
                        "Indonesia",
                        "Iran (Islamic Republic of)",
                        "Iraq",
                        "Ireland",
                        "Israel",
                        "Italy",
                        "Jamaica",
                        "Japan",
                        "Jordan",
                        "Kazakhstan",
                        "Kenya",
                        "Kiribati",
                        "Kuwait",
                        "Kyrgyzstan",
                        "Lao People’s Democratic Republic",
                        "Latvia",
                        "Lebanon",
                        "Lesotho",
                        "Liberia",
                        "Libya",
                        "Liechtenstein",
                        "Lithuania",
                        "Luxembourg",
                        "Madagascar",
                        "Malawi",
                        "Malaysia",
                        "Maldives",
                        "Mali",
                        "Malta",
                        "Marshall Islands",
                        "Mauritania",
                        "Mauritius",
                        "Mexico",
                        "Micronesia (Federated States of)",
                        "Monaco",
                        "Mongolia",
                        "Montenegro",
                        "Morocco",
                        "Mozambique",
                        "Myanmar",
                        "Namibia",
                        "Nauru",
                        "Nepal",
                        "Netherlands",
                        "New Zealand",
                        "Nicaragua",
                        "Niger",
                        "Nigeria",
                        "North Macedonia",
                        "Norway",
                        "Oman",
                        "Pakistan",
                        "Palau",
                        "Panama",
                        "Papua New Guinea",
                        "Paraguay",
                        "Peru",
                        "Philippines",
                        "Poland",
                        "Portugal",
                        "Qatar",
                        "Republic of Korea",
                        "Republic of Moldova",
                        "Romania",
                        "Russian Federation",
                        "Rwanda",
                        "Saint Kitts and Nevis",
                        "Saint Lucia",
                        "Saint Vincent and the Grenadines",
                        "Samoa",
                        "San Marino",
                        "Sao Tome and Principe",
                        "Saudi Arabia",
                        "Senegal",
                        "Serbia",
                        "Seychelles",
                        "Sierra Leone",
                        "Singapore",
                        "Slovakia",
                        "Slovenia",
                        "Solomon Islands",
                        "Somalia",
                        "South Africa",
                        "South Sudan",
                        "Spain",
                        "Sri Lanka",
                        "Sudan",
                        "Suriname",
                        "Sweden",
                        "Switzerland",
                        "Syrian Arab Republic",
                        "Tajikistan",
                        "Thailand",
                        "Timor-Leste",
                        "Togo",
                        "Tonga",
                        "Trinidad and Tobago",
                        "Tunisia",
                        "Turkey",
                        "Turkmenistan",
                        "Tuvalu",
                        "Uganda",
                        "Ukraine",
                        "United Arab Emirates",
                        "United Kingdom of Great Britain and Northern Ireland",
                        "United Republic of Tanzania",
                        "United States of America",
                        "Uruguay",
                        "Uzbekistan",
                        "Vanuatu",
                        "Venezuela, Bolivarian Republic of",
                        "Viet Nam",
                        "Yemen",
                        "Zambia",
                        "Zimbabwe"
                    ],
                    "label": "Countries",
                    "description": "",
                    "fieldType": "CATEGORY",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "start_date": {
                    "label": "Start date",
                    "description": "",
                    "fieldType": "DATE",
                    "sourceType": "STORE",
                    "required": false
                },
                "cost_rating": {
                    "categories": [
                        "Low",
                        "Medium low",
                        "Medium high",
                        "High"
                    ],
                    "label": "Cost rating",
                    "description": "",
                    "fieldType": "CATEGORY",
                    "sourceType": "STORE",
                    "required": false
                },
                "description": {
                    "label": "Description",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "feasibility": {
                    "label": "Feasibility",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "dataiku_item": {
                    "references": [
                        {
                            "blueprintId": "bp.system.dataiku_project",
                            "fieldId": "governed_by"
                        }
                    ],
                    "computationType": "BACKREFERENCE",
                    "label": "Dataiku project",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "COMPUTE",
                    "required": false
                },
                "related_docs": {
                    "label": "Related documents",
                    "description": "",
                    "fieldType": "UPLOADED_FILE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "rollout_docs": {
                    "label": "Roll-out documents",
                    "description": "",
                    "fieldType": "UPLOADED_FILE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "cost_comments": {
                    "label": "Cost comments",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "delivery_docs": {
                    "label": "Delivery documents",
                    "description": "",
                    "fieldType": "UPLOADED_FILE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "govern_models": {
                    "references": [
                        {
                            "blueprintId": "bp.system.govern_model",
                            "fieldId": "govern_project"
                        }
                    ],
                    "computationType": "BACKREFERENCE",
                    "label": "Governed models",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "COMPUTE",
                    "required": false
                },
                "progress_docs": {
                    "label": "Progress documents",
                    "description": "",
                    "fieldType": "UPLOADED_FILE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "rollout_notes": {
                    "label": "Roll-out notes",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "delivery_notes": {
                    "label": "Delivery notes",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "govern_bundles": {
                    "references": [
                        {
                            "blueprintId": "bp.system.govern_bundle",
                            "fieldId": "govern_project"
                        }
                    ],
                    "computationType": "BACKREFERENCE",
                    "label": "Governed bundles",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "COMPUTE",
                    "required": false
                },
                "progress_notes": {
                    "label": "Progress notes",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "final_approvers": {
                    "allowedBlueprints": [
                        "bp.system.user",
                        "bp.system.group"
                    ],
                    "label": "Final approvers",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "govern_datasets": {
                    "references": [
                        {
                            "blueprintId": "bp.system.govern_dataset",
                            "fieldId": "govern_project"
                        }
                    ],
                    "computationType": "BACKREFERENCE",
                    "label": "Governed datasets",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "COMPUTE",
                    "required": false
                },
                "target_end_date": {
                    "label": "Target end date",
                    "description": "",
                    "fieldType": "DATE",
                    "sourceType": "STORE",
                    "required": false
                },
                "exploration_docs": {
                    "label": "Exploration documents",
                    "description": "",
                    "fieldType": "UPLOADED_FILE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "exploration_notes": {
                    "label": "Exploration notes",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "signoff_approvers": {
                    "allowedBlueprints": [
                        "bp.system.user",
                        "bp.system.group"
                    ],
                    "label": "Final approvers",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "qualification_docs": {
                    "label": "Qualification documents",
                    "description": "",
                    "fieldType": "UPLOADED_FILE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "business_initiative": {
                    "allowedBlueprints": [
                        "bp.system.business_initiative"
                    ],
                    "label": "Business initiative",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "STORE",
                    "required": false
                },
                "qualification_notes": {
                    "label": "Qualification notes",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "signoff_reviewers_it": {
                    "allowedBlueprints": [
                        "bp.system.user",
                        "bp.system.group"
                    ],
                    "label": "IT & Operations reviewers",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "progress_rollout_plan": {
                    "label": "Roll-out plan",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "signoff_reviewers_risk": {
                    "allowedBlueprints": [
                        "bp.system.user",
                        "bp.system.group"
                    ],
                    "label": "Risk & Compliance reviewers",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "qualification_risk_score": {
                    "min": 0,
                    "max": 100,
                    "label": "Risk score",
                    "description": "",
                    "fieldType": "NUMBER",
                    "sourceType": "STORE",
                    "required": false
                },
                "qualification_risk_rating": {
                    "categories": [
                        "Low",
                        "Medium low",
                        "Medium high",
                        "High"
                    ],
                    "label": "Risk rating",
                    "description": "",
                    "fieldType": "CATEGORY",
                    "sourceType": "STORE",
                    "required": false
                },
                "qualification_value_score": {
                    "min": 0,
                    "max": 100,
                    "label": "Value score",
                    "description": "",
                    "fieldType": "NUMBER",
                    "sourceType": "STORE",
                    "required": false
                },
                "qualification_project_plan": {
                    "label": "Project plan",
                    "description": "",
                    "fieldType": "UPLOADED_FILE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "qualification_value_rating": {
                    "categories": [
                        "Low",
                        "Medium low",
                        "Medium high",
                        "High"
                    ],
                    "label": "Value rating",
                    "description": "",
                    "fieldType": "CATEGORY",
                    "sourceType": "STORE",
                    "required": false
                },
                "signoff_reviewers_business": {
                    "allowedBlueprints": [
                        "bp.system.user",
                        "bp.system.group"
                    ],
                    "label": "Business reviewers",
                    "description": "",
                    "fieldType": "REFERENCE",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "qualification_risk_comments": {
                    "label": "Risk comments",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "qualification_value_comments": {
                    "label": "Value comments",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "use_case_technical_dimension": {
                    "categories": [
                        "AI/ML",
                        "Analytics",
                        "LLM/GenAI"
                    ],
                    "label": "Use case technical dimension",
                    "description": "",
                    "fieldType": "CATEGORY",
                    "sourceType": "STORE",
                    "required": false,
                    "listConfig": {
                        "cardinalityMin": 0
                    }
                },
                "qualification_feasibility_rating": {
                    "categories": [
                        "Low",
                        "Medium low",
                        "Medium high",
                        "High"
                    ],
                    "label": "Feasibility rating",
                    "description": "",
                    "fieldType": "CATEGORY",
                    "sourceType": "STORE",
                    "required": false
                },
                "qualification_resulting_decision": {
                    "categories": [
                        "Go",
                        "No go"
                    ],
                    "label": "Resulting decision",
                    "description": "",
                    "fieldType": "CATEGORY",
                    "sourceType": "STORE",
                    "required": false
                },
                "qualification_comment_on_decision": {
                    "label": "Comment on decision",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                },
                "qualification_feasibility_comments": {
                    "label": "Feasibility comments",
                    "description": "",
                    "fieldType": "TEXT",
                    "sourceType": "STORE",
                    "required": false
                }
            },
            "workflowDefinition": {
                "stepDefinitions": [
                    {
                        "id": "exploration",
                        "name": "Exploration"
                    },
                    {
                        "id": "qualification",
                        "name": "Qualification"
                    },
                    {
                        "id": "progress",
                        "name": "In Progress"
                    },
                    {
                        "id": "rollout",
                        "name": "Validation and Roll-out"
                    },
                    {
                        "id": "delivery",
                        "name": "Delivered"
                    }
                ]
            },
            "logicalHookList": [
                {
                    "name": "Update risk/value scores",
                    "description": "",
                    "phases": [
                        "CREATE",
                        "UPDATE"
                    ],
                    "script": "from govern.core.handler import get_handler\n\ndef map_category(cat):\n    x = cat.lower()\n    return {\n        'low': 20,\n        'medium low': 40,\n        'medium high': 60,\n        'high': 80\n    }[x]\n\nhandler = get_handler()\nhookPhase = handler.hookPhase\nartifact = handler.artifact\nrisk_rating = artifact.fields.get('qualification_risk_rating')\nvalue_rating = artifact.fields.get('qualification_value_rating')\nif risk_rating is not None:\n    artifact.fields['qualification_risk_score'] = 100 - map_category(risk_rating)\nelse:\n    artifact.fields['qualification_risk_score'] = None\n\nif value_rating is not None:\n    artifact.fields['qualification_value_score'] = map_category(value_rating)\nelse:\n    artifact.fields['qualification_value_score'] = None"
                }
            ],
            "hierarchicalParentFieldId": "business_initiative",
            "uiDefinition": {
                "views": {
                    "main": {
                        "type": "card",
                        "viewComponent": {
                            "type": "container",
                            "layout": {
                                "type": "sequential",
                                "viewComponents": [
                                    {
                                        "type": "container",
                                        "layout": {
                                            "type": "sequential",
                                            "viewComponents": [
                                                {
                                                    "type": "card-reference-field",
                                                    "bigCardViews": [],
                                                    "fieldId": "business_initiative",
                                                    "label": "Business initiative",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "text-field",
                                                    "keepSourceFormat": false,
                                                    "fieldId": "description",
                                                    "label": "Description",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "uploaded-file-field",
                                                    "fieldId": "rollout_docs",
                                                    "label": "Roll-out documents",
                                                    "description": "",
                                                    "documentation": ""
                                                }
                                            ]
                                        },
                                        "label": "Project description",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "container",
                                        "layout": {
                                            "type": "sequential",
                                            "viewComponents": [
                                                {
                                                    "type": "category-field",
                                                    "fieldId": "countries",
                                                    "label": "Countries",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "category-field",
                                                    "fieldId": "use_case_technical_dimension",
                                                    "label": "Use case technical dimension",
                                                    "description": "",
                                                    "documentation": ""
                                                }
                                            ]
                                        },
                                        "label": "Project type and scope",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "container",
                                        "layout": {
                                            "type": "sequential",
                                            "viewComponents": [
                                                {
                                                    "type": "card-reference-field",
                                                    "bigCardViews": [],
                                                    "fieldId": "govern_models",
                                                    "label": "Governed models",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "card-reference-field",
                                                    "bigCardViews": [],
                                                    "fieldId": "govern_bundles",
                                                    "label": "Governed bundles",
                                                    "description": "",
                                                    "documentation": ""
                                                }
                                            ]
                                        },
                                        "label": "Related items",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "container",
                                        "layout": {
                                            "type": "sequential",
                                            "viewComponents": [
                                                {
                                                    "type": "card-reference-field",
                                                    "bigCardViews": [],
                                                    "fieldId": "signoff_reviewers_it",
                                                    "label": "IT & Operations reviewers",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "card-reference-field",
                                                    "bigCardViews": [],
                                                    "fieldId": "signoff_reviewers_risk",
                                                    "label": "Risk & Compliance reviewers",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "card-reference-field",
                                                    "bigCardViews": [],
                                                    "fieldId": "signoff_reviewers_business",
                                                    "label": "Business reviewers",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "card-reference-field",
                                                    "bigCardViews": [],
                                                    "fieldId": "final_approvers",
                                                    "label": "Final approvers",
                                                    "description": "",
                                                    "documentation": ""
                                                }
                                            ]
                                        },
                                        "label": "Sign-off reviewers and approvers",
                                        "description": "Define who can give feedbacks on and can sign-off the model versions for this project",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "container",
                                        "layout": {
                                            "type": "sequential",
                                            "viewComponents": [
                                                {
                                                    "type": "category-field",
                                                    "fieldId": "qualification_risk_rating",
                                                    "label": "Risk rating",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "category-field",
                                                    "fieldId": "qualification_value_rating",
                                                    "label": "Value rating",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "category-field",
                                                    "fieldId": "qualification_feasibility_rating",
                                                    "label": "Feasibility rating",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "category-field",
                                                    "fieldId": "qualification_resulting_decision",
                                                    "label": "Resulting decision",
                                                    "description": "",
                                                    "documentation": ""
                                                }
                                            ]
                                        },
                                        "label": "Qualification snapshot",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "container",
                                        "layout": {
                                            "type": "sequential",
                                            "viewComponents": [
                                                {
                                                    "type": "date-field",
                                                    "fieldId": "start_date",
                                                    "label": "Start date",
                                                    "description": "",
                                                    "documentation": ""
                                                },
                                                {
                                                    "type": "date-field",
                                                    "fieldId": "target_end_date",
                                                    "label": "Target end date",
                                                    "description": "",
                                                    "documentation": ""
                                                }
                                            ]
                                        },
                                        "label": "Project schedule",
                                        "description": "",
                                        "documentation": ""
                                    }
                                ]
                            },
                            "label": "",
                            "description": "",
                            "documentation": ""
                        },
                        "label": "Project info",
                        "description": ""
                    },
                    "rollout": {
                        "type": "card",
                        "viewComponent": {
                            "type": "container",
                            "layout": {
                                "type": "sequential",
                                "viewComponents": [
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "rollout_notes",
                                        "label": "Notes",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "uploaded-file-field",
                                        "fieldId": "rollout_docs",
                                        "label": "Supporting documents",
                                        "description": "",
                                        "documentation": ""
                                    }
                                ]
                            },
                            "label": "",
                            "description": "",
                            "documentation": ""
                        },
                        "label": "Roll-out info",
                        "description": ""
                    },
                    "delivery": {
                        "type": "card",
                        "viewComponent": {
                            "type": "container",
                            "layout": {
                                "type": "sequential",
                                "viewComponents": [
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "delivery_notes",
                                        "label": "Notes",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "uploaded-file-field",
                                        "fieldId": "delivery_docs",
                                        "label": "Supporting documents",
                                        "description": "",
                                        "documentation": ""
                                    }
                                ]
                            },
                            "label": "",
                            "description": "",
                            "documentation": ""
                        },
                        "label": "Delivery info",
                        "description": ""
                    },
                    "progress": {
                        "type": "card",
                        "viewComponent": {
                            "type": "container",
                            "layout": {
                                "type": "sequential",
                                "viewComponents": [
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "progress_notes",
                                        "label": "Notes",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "progress_rollout_plan",
                                        "label": "Roll-out plan",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "uploaded-file-field",
                                        "fieldId": "progress_docs",
                                        "label": "Supporting documents",
                                        "description": "",
                                        "documentation": ""
                                    }
                                ]
                            },
                            "label": "",
                            "description": "",
                            "documentation": ""
                        },
                        "label": "Progress info",
                        "description": ""
                    },
                    "exploration": {
                        "type": "card",
                        "viewComponent": {
                            "type": "container",
                            "layout": {
                                "type": "sequential",
                                "viewComponents": [
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "exploration_notes",
                                        "label": "Notes",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "uploaded-file-field",
                                        "fieldId": "exploration_docs",
                                        "label": "Supporting documents",
                                        "description": "",
                                        "documentation": ""
                                    }
                                ]
                            },
                            "label": "",
                            "description": "",
                            "documentation": ""
                        },
                        "label": "Exploration info",
                        "description": ""
                    },
                    "qualification": {
                        "type": "card",
                        "viewComponent": {
                            "type": "container",
                            "layout": {
                                "type": "sequential",
                                "viewComponents": [
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "qualification_notes",
                                        "label": "Notes",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "uploaded-file-field",
                                        "fieldId": "qualification_docs",
                                        "label": "Supporting documents",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "category-field",
                                        "fieldId": "qualification_risk_rating",
                                        "label": "Risk rating",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "qualification_risk_comments",
                                        "label": "Risk comments",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "category-field",
                                        "fieldId": "qualification_value_rating",
                                        "label": "Value rating",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "qualification_value_comments",
                                        "label": "Value comments",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "category-field",
                                        "fieldId": "cost_rating",
                                        "label": "Cost rating",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "cost_comments",
                                        "label": "Cost comments",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "category-field",
                                        "fieldId": "qualification_feasibility_rating",
                                        "label": "Feasibility rating",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "qualification_feasibility_comments",
                                        "label": "Feasibility comments",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "category-field",
                                        "fieldId": "qualification_resulting_decision",
                                        "label": "Resulting decision",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "text-field",
                                        "keepSourceFormat": false,
                                        "fieldId": "qualification_comment_on_decision",
                                        "label": "Comment on decision",
                                        "description": "",
                                        "documentation": ""
                                    },
                                    {
                                        "type": "uploaded-file-field",
                                        "fieldId": "qualification_project_plan",
                                        "label": "Project plan",
                                        "description": "",
                                        "documentation": ""
                                    }
                                ]
                            },
                            "label": "",
                            "description": "",
                            "documentation": ""
                        },
                        "label": "Qualification info",
                        "description": ""
                    },
                    "row_business_initiative": {
                        "type": "row",
                        "viewComponents": [
                            {
                                "type": "card-reference-field",
                                "bigCardViews": [],
                                "fieldId": "business_initiative",
                                "label": "Business initiative",
                                "description": "",
                                "documentation": ""
                            }
                        ],
                        "label": "Business initiative",
                        "description": ""
                    }
                },
                "uiStepDefinitions": {
                    "rollout": {
                        "viewId": "rollout"
                    },
                    "delivery": {
                        "viewId": "delivery"
                    },
                    "progress": {
                        "viewId": "progress"
                    },
                    "exploration": {
                        "viewId": "exploration"
                    },
                    "qualification": {
                        "viewId": "qualification"
                    }
                },
                "artifactPageViewId": "main"
            },
            "instructions": "Do not edit the workflow and the existing fields, only field additions are possible"
        },
        "originVersionId": "bv.system.default",
        "signoffsConfigurations": [],
        "migrationPaths": [
            {
                "id": "mp.academy_to_unknown",
                "name": "Academy to Unknown",
                "description": "",
                "script": "from govern.core.migration_handler import get_migration_handler\n\nhandler = get_migration_handler()\n### Get the artifact to migrate\ntarget_artifact = handler.target_artifact\n### Get the source enriched artifact\nsource_enriched_artifact = handler.source_enriched_artifact\n### Get the target blueprint version definition\ntarget_blueprint_version = handler.target_blueprint_version\n\n### -------------------------------\n### The target_artifact variable contains the content of the artifact before the migration\n### Modify it in place to apply the migration. \n### Once the script is executed target_artifact will be saved with the new template. \n### Edit the name of the artifact during the migration\n# target_artifact.name = target_artifact.name + \"_migrated\"\n\n### -------------------------------\n### Edit the fields\n# fields = target_artifact.fields\n# fields[\"new_field\"] = \"value\"\n\n### If you provide a field that is not present in the target blueprint version definition, the migration will fail.\n### Also make sure to fill all required fields of the target definition.\n\n### -------------------------------\n### Use target_blueprint_version to have the target field definitions. i\n# target_fields_definition = target_blueprint_version.fieldDefinitions\n\n### -------------------------------\n### Use the public api and retrieve the content of an artifact:\n# artifact = handler.client.get_artifact(\"ar.1773\")\n\n\n",
                "blueprintVersionIdFrom": {
                    "blueprintId": "bp.system.govern_project",
                    "versionId": "bv._academy_project"
                },
                "blueprintVersionIdTo": {
                    "blueprintId": "bp.system.govern_project",
                    "versionId": "bv.dataiku_standard_v2"
                },
                "status": "ACTIVE"
            },
            {
                "id": "mp.academy_to_dataiku_standard",
                "name": "Academy to Dataiku Standard",
                "description": "",
                "script": "from govern.core.migration_handler import get_migration_handler\n\nhandler = get_migration_handler()\n### Get the artifact to migrate\ntarget_artifact = handler.target_artifact\n### Get the source enriched artifact\nsource_enriched_artifact = handler.source_enriched_artifact\n### Get the target blueprint version definition\ntarget_blueprint_version = handler.target_blueprint_version\n\n### -------------------------------\n### The target_artifact variable contains the content of the artifact before the migration\n### Modify it in place to apply the migration. \n### Once the script is executed target_artifact will be saved with the new template. \n\n### Edit the name of the artifact during the migration\ntarget_artifact.name = target_artifact.name + \"_migrated\"\n\n\n### -------------------------------\n### Edit the fields\n\nfields = target_artifact.fields\n\nif target_artifact.fields.get(\"rollout_docs\") is not None:\n  del target_artifact.fields[\"rollout_docs\"]\n\n# fields[\"related_docs\"] \n# fields[\"sponsors\"] \n\n",
                "blueprintVersionIdFrom": {
                    "blueprintId": "bp.system.govern_project",
                    "versionId": "bv._academy_project"
                },
                "blueprintVersionIdTo": {
                    "blueprintId": "bp.system.govern_project",
                    "versionId": "bv.system.default"
                },
                "status": "ACTIVE"
            }
          ]
       }
    }
    
  6. Keep the Import migrations field set to Fail import on missing blueprint versions.

  7. Click Confirm.

A Dataiku screenshot of the import new blueprint version window.

The import fails because one of the included migrations references a blueprint version that does not exist in your instance.

Ignore migrations#

Let’s try again!

  1. Click Create New Version > Import new version again.

  2. Copy and paste the same JSON script into the content field.

  3. For the Import migrations field, choose Ignore migrations on missing blueprint versions.

  4. Click Confirm.

    Note

    Because we chose to ignore certain migrations, the import should not fail. The template and one of the migrations should successfully import.

  5. The new template is not active yet, so open the More options menu for Academy Project and select Activate version > Activate.

  6. The migration is also not active yet, so switch to the Migrations tab.

  7. Open the More options menu for the Academy to Dataiku Standard migration and select Activate migration path > Activate.

A Dataiku screenshot highlighting the steps to activate the migration.

Create a project with the new template#

Now we’ll create a Govern project using the imported template.

  1. From the Dataiku Govern homepage, navigate to the Governed projects page.

  2. Click Create > Govern project (Academy Project).

  3. Name it <YOUR_INITIALS> Academy Project.

  4. Open the project.

  5. Take a moment to review the fields on the Overview page. We’ll perform a migration next where these fields will change.

Note

This Govern project is not linked to a Dataiku project in the Design node. To learn more, see Create Govern project.

Change the model template#

Imagine that you need to switch your project from the Academy template to the Dataiku Standard template. You can do so using a blueprint migration.

Since the imported blueprint already includes the necessary migration, all you need to do is apply the migration to the project.

  1. Click on the Template migration button icon. template migration button in the item header.

  2. Select the migration and click Apply.

Notice how the project page looks different now! This migration:

  • Removes the Roll-out documents field.

  • Adds a Sponsors field.

  • Adds a Related documents field.

  • Appends the word migrated to the Govern project title.

An image of the Dataiku project before and after the migration, highlighting changed fields.

What’s next?#

Visit the reference documentation for more on blueprints and blueprint versions.