Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MINOR: Add Governance Workflow documentation #19029

Merged
merged 3 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions openmetadata-docs/content/v1.6.x/collate-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -792,6 +792,36 @@ site_menu:
url: /how-to-guides/data-governance/domains-&-data-products/domains
- category: How-to Guides / Data Governance / Domains & Data Product / How to Use Data Products
url: /how-to-guides/data-governance/domains-&-data-products/data-products
- category: How-to Guides / Data Governance / Workflows
url: /how-to-guides/data-governance/workflows
- category: How-to Guides / Data Governance / Workflows / Default Workflows
url: /how-to-guides/data-governance/workflows/default-workflows
- category: How-to Guides / Data Governance / Workflows / Default Workflows / Glossary Approval Workflow
url: /how-to-guides/data-governance/workflows/default-workflows/glossary-approval
- category: How-to Guides / Data Governance / Workflows / Default Workflows / Table Certification Workflow
url: /how-to-guides/data-governance/workflows/default-workflows/table-certification
- category: How-to Guides / Data Governance / Workflows / Default Workflows / Dashboard Certification Workflow
url: /how-to-guides/data-governance/workflows/default-workflows/dashboard-certification
- category: How-to Guides / Data Governance / Workflows / Elements
url: /how-to-guides/data-governance/workflows/elements
- category: How-to Guides / Data Governance / Workflows / Elements / Triggers
url: /how-to-guides/data-governance/workflows/elements/triggers
- category: How-to Guides / Data Governance / Workflows / Elements / Triggers / Event Based Entity Trigger
url: /how-to-guides/data-governance/workflows/elements/triggers/event-based-entity-trigger
- category: How-to Guides / Data Governance / Workflows / Elements / Triggers / Periodic Batch Entity Trigger
url: /how-to-guides/data-governance/workflows/elements/triggers/periodic-batch-entity-trigger
- category: How-to Guides / Data Governance / Workflows / Elements / Nodes
url: /how-to-guides/data-governance/workflows/elements/nodes
- category: How-to Guides / Data Governance / Workflows / Elements / Nodes / Check Entity Attributes
url: /how-to-guides/data-governance/workflows/elements/nodes/check-entity-attributes
- category: How-to Guides / Data Governance / Workflows / Elements / Nodes / Create User Task
url: /how-to-guides/data-governance/workflows/elements/nodes/create-user-task
- category: How-to Guides / Data Governance / Workflows / Elements / Nodes / Set Asset Certification
url: /how-to-guides/data-governance/workflows/elements/nodes/set-asset-certification
- category: How-to Guides / Data Governance / Workflows / Elements / Nodes / Set Glossary Term Status
url: /how-to-guides/data-governance/workflows/elements/nodes/set-glossary-term-status
- category: How-to Guides / Data Governance / Workflows / How to Edit a Workflow
url: /how-to-guides/data-governance/workflows/how-to-edit-workflow

- category: Getting Started
url: /getting-started
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,18 @@ Watch the video to learn more about **[Glossary Approval Workflow](https://www.y

To automate the approval workflow, ensure that your Glossary has **Reviewers** assigned. If you glossary has reviewers assigned, the glossary approval workflow gets triggered when a **New Term** is added.

- The new term will show up in the Glossary, but will be marked as **Draft**.
- The new term will show up in the Glossary, but will be marked as **Draft**.
- This term will transition into the **In Review** status.
- Only the assigned **Reviewers** can Approve or Reject the term.
- A **Task** is assigned for the Reviewers.
- The details of the glossary term can be viewed in the **Overview Tab**.
- Users can discuss further about the term by **replying** on the task.
- Other users can be pulled into the conversation using **@mentions**.
- The approved terms will have the **Approved** label next to them.
- Similarly, the rejected terms will be marked as **Rejected**.
- If a **Rejected** or **Approved** term is updated, it will trigger the workflow again and it will get back to **In Review**.

{% note noteType="Warning" %}
{% note noteType="Warning" %}
In case, the glossary **does not have any Reviewers** assigned, then the glossary terms will be **Approved** by default.
{% /note noteType="Warning" %}
{% /note %}
Expand All @@ -33,4 +35,4 @@ In case, the glossary **does not have any Reviewers** assigned, then the glossar
icon="MdArrowForward"
href="/how-to-guides/data-governance/glossary/styling"%}
Associate glossary terms to data assets making it easier for data discovery
{%/inlineCallout%}
{%/inlineCallout%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Governance Workflows - Dashboard Certification Workflow (Default)
slug: /how-to-guides/data-governance/workflows/default-workflows/dashbaord-certification
collate: true
---

# Governance Workflows - Dashboard Certification Workflow (Default)

The **Dashboard Certification Workflow** is a periodic batch workflow designed to automatically manage the certification process for dashboards within Collate.
It is triggered periodically based on the configured scheduled, it fetches the assets based on the filters and it certifies dashbaords based on their attributes.

{% image src="/images/v1.6/how-to-guides/governance/workflows-table-certification" alt="dashbaord-certification" /%}

## Workflow Elements

- **Owners and Description are not Null nor Empty**
This task checks where the dashbaord has an owner and a description

If either attribute is missing or empty, the workflow moves to **Don't set certification**.
Otherwise, the workflow moves to **Entity is Tier 1 or Tier 2**.

- **Entity is Tier 1 or Tier 2**
This task checks if the dashbaord is categorized under *Tier 1* or *Tier 2*.

If the dashbaord is either *Tier 1* or *Tier 2*, the workflow moves to **Entity is Tier 1**.
Otherwise, the workflow moves to **Set Bronze Certification**.

- **Entity is Tier 1**
This task checks if the dashbaord is specifically *Tier 1*.

If the dashbaord is *Tier 1*, the workflow moves to **Set Gold Certification**.
Otherwise, the workflow moves to **Set Silver Certification**.

- **Set No Certification**
Sets the dashbaord certification to *None*.

- **Set Bronze Certification**
Sets the dashbaord certification to *Bronze*.

- **Set Silver Certification**
Sets the dashbaord certification to *Silver*.

- **Set Gold Certification**
Sets the dashbaord certification to *Gold*.
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Governance Workflows - Glossary Approval Workflow (Default)
slug: /how-to-guides/data-governance/workflows/default-workflows/glossary-approval
collate: true
---

# Governance Workflows - Glossary Approval Workflow (Default)

The **Glossary Approval Workflow** is designed to define the process of updating the status of Glossary Terms within Collate.
It is triggered when a Glossary Term is created or updated and it ensures it undergoes a review process until it reaches the desired status.

{% image src="/images/v1.6/how-to-guides/governance/workflows-glossary-approval" alt="glossary-approval" /%}

## Workflow Elements

- **Check if Glossary Term has Reviewers**
This task checks whether the glossary term has any reviewers assigned.

If no reviewers are found, the glossary term is directly marked as approved.
If reviewers are found, the workflow moves to **Check if Glossary Term is Ready to be Reviewed**.

- **Check if Glossary Term is Ready to be Reviewed**
This task verifies if the glossary term is ready for review based on the presence of a description.

If the glossary term is ready for review, the workflow moves to **Set Status to 'In Review'**.
If the glossary term is not ready, the workflow moves to **Set Status to 'Draft'**.

- **Set Status to 'In Review'**
If the glossary term is ready, its status is set to "In Review".

- **Set Status to 'Draft'**
If the glossary term is not ready for review, its status is set to "Draft".

- **Approval**
A user approval task where reviewers approve or reject the glossary term.

If the glossary term is *approved* by the reviewers, the workflow moves to **Set Status to 'Approved'**.
If the glossary term is *rejected* by the reviewers, the workflow moves to **Set Status to 'Rejected'**.

- **Set Status to 'Approved'**
If the glossary term is approved, its status is updated to "Approved".

- **Set Status to 'Rejected'**
If the glossary term is rejected, its status is updated to "Rejected".
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Governance Workflows - Default Workflows
slug: /how-to-guides/data-governance/workflows/default-workflows
collate: true
---

# Governance Workflows - Default Workflows

These workflows are a good starting point for different governance tasks. They should be used as they are or modified to suit your needs.

{%inlineCalloutContainer%}
{%inlineCallout
color="violet-70"
bold="Glossary Approval Workflow"
icon="MdMenuBook"
href="/how-to-guides/data-governance/workflows/default-workflows/glossary-approval"%}
Define how the Glossary Approval Workflow should work.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Table Certification Workflow"
icon="MdMenuBook"
href="/how-to-guides/data-governance/workflows/default-workflows/table-certification"%}
Define how to classify your Table Asset with different Certification Levels to indicate data trustworthiness and quality.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Dashboard Certification Workflow"
icon="MdMenuBook"
href="/how-to-guides/data-governance/workflows/default-workflows/dashboard-certification"%}
Define how to classify your Dashboard Asset with different Certification Levels to indicate data trustworthiness and quality.
{%/inlineCallout%}
{%/inlineCalloutContainer%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Governance Workflows - Table Certification Workflow (Default)
slug: /how-to-guides/data-governance/workflows/default-workflows/table-certification
collate: true
---

# Governance Workflows - Table Certification Workflow (Default)

The **Table Certification Workflow** is a periodic batch workflow designed to automatically manage the certification process for tables within Collate.
It is triggered periodically based on the configured scheduled, it fetches the assets based on the filters and it certifies tables based on their attributes.

{% image src="/images/v1.6/how-to-guides/governance/workflows-table-certification" alt="table-certification" /%}

## Workflow Elements

- **Owners and Description are not Null nor Empty**
This task checks where the table has an owner and a description

If either attribute is missing or empty, the workflow moves to **Don't set certification**.
Otherwise, the workflow moves to **Entity is Tier 1 or Tier 2**.

- **Entity is Tier 1 or Tier 2**
This task checks if the table is categorized under *Tier 1* or *Tier 2*.

If the table is either *Tier 1* or *Tier 2*, the workflow moves to **Entity is Tier 1**.
Otherwise, the workflow moves to **Set Bronze Certification**.

- **Entity is Tier 1**
This task checks if the table is specifically *Tier 1*.

If the table is *Tier 1*, the workflow moves to **Set Gold Certification**.
Otherwise, the workflow moves to **Set Silver Certification**.

- **Set No Certification**
Sets the table certification to *None*.

- **Set Bronze Certification**
Sets the table certification to *Bronze*.

- **Set Silver Certification**
Sets the table certification to *Silver*.

- **Set Gold Certification**
Sets the table certification to *Gold*.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Governance Workflows - Elements
slug: /how-to-guides/data-governance/workflows/elements
collate: true
---

# Governance Workflows - Elements

{%inlineCalloutContainer%}
{%inlineCallout
color="violet-70"
bold="Trigger"
icon="MdMenuBook"
href="/how-to-guides/data-governance/workflows/elements/triggers"%}
Defines what initiates a workflow (e.g., an event or a scheduled action)
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Nodes"
icon="MdMenuBook"
href="/how-to-guides/data-governance/workflows/elements/nodes"%}
Represent the building blocks of a workflow. You can configure each node to specify conditions, actions or tasks.
{%/inlineCallout%}
{%/inlineCalloutContainer%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Governance Workflows - Check Entity Attributes
slug: /how-to-guides/data-governance/workflows/elements/nodes/check-entity-attributes
collate: true
---

# Governance Workflows - Check Entity Attributes

The **Check Entity Attributes** node is used to validate whether the attributes of an entity meet specified rules.
This is essential to be able to branch the workflow depending on different characteristics of a given asset, automating decision-making based on it.

## Configuration

After you define a **Display Name** and a **Description** for this node, you can set different rules and branch the workflow.

## Example

We can see an example of this node's configuration below, where we define that it will check:

- That the **Owners** attribute is set.
- That the **Description** attribute is set.

{% image src="/images/v1.6/how-to-guides/governance/workflows-check-entity-attributes" alt="check-entity-attributes" /%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Governance Workflows - Create User Task
slug: /how-to-guides/data-governance/workflows/elements/nodes/create-user-task
collate: true
---

# Governance Workflows - Create User Task

The **Create User Task** node is used to define a task that requires a designated user (or team) to complete.
This is essential to allow user input within the workflow.

**As of now, this node is focused on the Glossary Approval Task. It will be updated to enable more tasks in the next releases.**

## Configuration

After you define a **Display Name** and a **Description** for this node, you can define the assignees for the task.

**As of now, the assignees will be the Reviewers for the Glossary Term**

## Example

We can see an example of this node's configuration below:

{% image src="/images/v1.6/how-to-guides/governance/workflows-create-user-task" alt="create-user-task" /%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Governance Workflows - Nodes
slug: /how-to-guides/data-governance/workflows/elements/nodes
collate: true
---

# Governance Workflows - Nodes

You can find below a list of available Nodes that can be used with the Governance Workflows.

{%inlineCalloutContainer%}
{%inlineCallout
color="violet-70"
bold="Trigger"
icon="MdMenuBook"
href="/how-to-guides/data-governance/workflows/elements/nodes/check-entity-attributes"%}
Allows to check different attributes on a given entity and branch the workflow depending on the result.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Trigger"
icon="MdMenuBook"
href="/how-to-guides/data-governance/workflows/elements/nodes/create-user-task"%}
Allows to create a Task for a user to resolve.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Trigger"
icon="MdMenuBook"
href="/how-to-guides/data-governance/workflows/elements/nodes/set-asset-certification"%}
Allows to set an Asset Certification.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Trigger"
icon="MdMenuBook"
href="/how-to-guides/data-governance/workflows/elements/nodes/set-glossary-term-status"%}
Allows to set a Glossary Term Status.
{%/inlineCallout%}
{%/inlineCalloutContainer%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Governance Workflows - Set Asset Certification
slug: /how-to-guides/data-governance/workflows/elements/nodes/set-asset-certification
collate: true
---

# Governance Workflows - Set Asset Certification

The **Set Asset Certification** node allows workflows to set the **Certification** for an Asset to a configured value.
It is used to automate the process of certifying assets within Collate, ensuring that they are assigned an appropriate certification level.

## Configuration

After you define a **Display Name** and a **Description** for this node, you can define the certification to set the Asset to.

## Example

We can see an example of this node's configuration below:

{% image src="/images/v1.6/how-to-guides/governance/workflows-set-asset-certification" alt="set-asset-certification" /%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Governance Workflows - Set Glossary Term Status
slug: /how-to-guides/data-governance/workflows/elements/nodes/set-glossary-term-status
collate: true
---

# Governance Workflows - Set Glossary Term Status

The **Set Glossary Term Status** node allows workflows to set the **Status** for a Glossary Term to a configured value.
This is part of Collate's workflow automation tools and helps streamline the process of managing Glossary Terms,
ensuring they are updated according to the desired governance policies.

## Configuration

After you define a **Display Name** and a **Description** for this node, you can define the status to set the Glossary Term to.

## Example

We can see an example of this node's configuration below:

{% image src="/images/v1.6/how-to-guides/governance/workflows-set-glossary-term-status" alt="set-glossary-term-status" /%}
Loading
Loading