diff --git a/openmetadata-docs/content/v1.6.x/collate-menu.md b/openmetadata-docs/content/v1.6.x/collate-menu.md index c89a6e1bd98d..766a3e52c570 100644 --- a/openmetadata-docs/content/v1.6.x/collate-menu.md +++ b/openmetadata-docs/content/v1.6.x/collate-menu.md @@ -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 diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/glossary/approval.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/glossary/approval.md index 000129b371ee..230d7b2a3ad9 100644 --- a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/glossary/approval.md +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/glossary/approval.md @@ -13,7 +13,8 @@ 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**. @@ -21,8 +22,9 @@ To automate the approval workflow, ensure that your Glossary has **Reviewers** a - 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 %} @@ -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%} \ No newline at end of file +{%/inlineCallout%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/dashboard-certification.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/dashboard-certification.md new file mode 100644 index 000000000000..6fca27db1101 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/dashboard-certification.md @@ -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*. diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/glossary-approval.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/glossary-approval.md new file mode 100644 index 000000000000..6fa986c24faf --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/glossary-approval.md @@ -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". diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/index.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/index.md new file mode 100644 index 000000000000..c84062412089 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/index.md @@ -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%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/table-certification.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/table-certification.md new file mode 100644 index 000000000000..6096f40267c8 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/default-workflows/table-certification.md @@ -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*. diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/index.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/index.md new file mode 100644 index 000000000000..0221eb8e2e7c --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/index.md @@ -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%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/check-entity-attributes.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/check-entity-attributes.md new file mode 100644 index 000000000000..acfe2eb99c45 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/check-entity-attributes.md @@ -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" /%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/create-user-task.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/create-user-task.md new file mode 100644 index 000000000000..84b3ba99effc --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/create-user-task.md @@ -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" /%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/index.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/index.md new file mode 100644 index 000000000000..381fcdd05edb --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/index.md @@ -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%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/set-asset-certification.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/set-asset-certification.md new file mode 100644 index 000000000000..4b745417e59a --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/set-asset-certification.md @@ -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" /%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/set-glossary-term-status.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/set-glossary-term-status.md new file mode 100644 index 000000000000..f4597a52f668 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/nodes/set-glossary-term-status.md @@ -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" /%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/triggers/event-based-entity-trigger.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/triggers/event-based-entity-trigger.md new file mode 100644 index 000000000000..d1e897b458f7 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/triggers/event-based-entity-trigger.md @@ -0,0 +1,29 @@ +--- +title: Governance Workflows - Event Based Entity Trigger +slug: /how-to-guides/data-governance/workflows/elements/triggers/event-based-entity-trigger +collate: true +--- + +# Governance Workflows - Event Based Entity Trigger + +The **Event Based Entity Trigger** enables actions to be initiated based on specific events related to an entity. +These triggers are essential for automating workflows in response to entity state changes, such as when an entity is created or updated. +The trigger listens for predefined events and can be configured to exclude certain attribute modifications. + +## Configuration + +First you need to specify a **Data Asset** on which the Workflow will operate + +Then, the Trigger can be configured to respond to the following events: + +- **Created**: Triggered when a new entity is created. +- **Updated**: Triggered when an existing entity is updated. + +Additionally, this trigger allows fine-tuning by excluding certain events that modify only specific attributes of the entity. + + +### Example + +As an example we can check the default **Glossary Approval Workflow**, shipped with Collate. + +{% image src="/images/v1.6/how-to-guides/governance/workflows-event-based-entity-trigger" alt="event-based-entity-trigger-example" /%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/triggers/index.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/triggers/index.md new file mode 100644 index 000000000000..f6ebdfcbeca9 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/triggers/index.md @@ -0,0 +1,26 @@ +--- +title: Governance Workflows - Triggers +slug: /how-to-guides/data-governance/workflows/elements/triggers +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="Event Based Entity Trigger" + icon="MdMenuBook" + href="/how-to-guides/data-governance/workflows/elements/triggers/event-based-entity-trigger"%} + Triggers the start of the Workflow based on an event. + {%/inlineCallout%} + {%inlineCallout + color="violet-70" + bold="Create User Task" + icon="MdMenuBook" + href="/how-to-guides/data-governance/workflows/elements/triggers/periodic-batch-entity-trigger"%} + Triggers the start of the Workflow based on a scheduled timer. + {%/inlineCallout%} +{%/inlineCalloutContainer%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/triggers/periodic-batch-entity-trigger.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/triggers/periodic-batch-entity-trigger.md new file mode 100644 index 000000000000..b9cc3a272441 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/elements/triggers/periodic-batch-entity-trigger.md @@ -0,0 +1,29 @@ +--- +title: Governance Workflows - Periodic Batch Entity Trigger +slug: /how-to-guides/data-governance/workflows/elements/triggers/periodic-batch-entity-trigger +collate: true +--- + +# Governance Workflows - Periodic Batch Entity Trigger + +The **Periodic Batch Entity Trigger** enables actions to be triggered on a periodic schedule, processing a batch of entitites at a time. +This type of trigger is useful for automating regular workflows that need to run on a schedule. + +## Configuration + +First you need to specify a **Data Asset** on which the Workflow will operate + +Then you can define different filters to define more specifically the assets you wish you run through this workflow. + +Finally you can define the trigger mechanism: + +- **On Demand**: Manually triggered from the UI. +- **Schedule**: Triggered on a given schedule + +Additionally, this trigger allows to optionally define the BatchSize to improve the fetching performance. **This should not be changed unless truly required.** + +### Example + +As an example we can check the default **Table Certification Workflow**, shipped with Collate. + +{% image src="/images/v1.6/how-to-guides/governance/workflows-periodic-batch-entity-trigger" alt="periodic-batch-entity-trigger" /%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/how-to-edit-workflow.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/how-to-edit-workflow.md new file mode 100644 index 000000000000..74243a3c6103 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/how-to-edit-workflow.md @@ -0,0 +1,33 @@ +--- +title: Governance Workflows - How to Edit +slug: /how-to-guides/data-governance/workflows/how-to-edit-workflow +collate: true +--- + +# Governance Workflows - How to Edit + +This is a small How-To guide to help you understand how to easily edit the workflow configurations. + +## Edit Trigger + +1. Click on the **Configuration** tab + +{% image src="/images/v1.6/how-to-guides/governance/workflows-how-to-edit-configuration" alt="how-to-edit-configuration-click" /%} + +2. Edit the needed fields and **Save** + +{% image src="/images/v1.6/how-to-guides/governance/workflows-how-to-edit-configuration-page" alt="how-to-edit-configuration-page" /%} + +## Edit Nodes + +1. Click on the **Workflow** tab + +{% image src="/images/v1.6/how-to-guides/governance/workflows-how-to-edit-workflow" alt="how-to-edit-workflow" /%} + +2. Click on the **Node** that you wish you edit + +{% image src="/images/v1.6/how-to-guides/governance/workflows-how-to-edit-node-click" alt="how-to-edit-node-click" /%} + +3. Edit the needed fields and **Submit** + +{% image src="/images/v1.6/how-to-guides/governance/workflows-how-to-edit-node-page" alt="how-to-edit-node-page" /%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/index.md b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/index.md new file mode 100644 index 000000000000..b923d5bcb133 --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/data-governance/workflows/index.md @@ -0,0 +1,64 @@ +--- +title: Governance Workflows +slug: /how-to-guides/data-governance/workflows +collate: true +--- + +# Governance Workflows + + +Governance Workflows in Collate enable teams to enforce organizational policies, ensure compliance and streamline collaborative processes. +As a **BETA** feature, Governance Workflows allows users to configure predefined workflows, with future updates planned to enable full creation and management capabilities. +Your feedback during this phase is invaluable to shape the feature's evolution. + +## Key Components + +{%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%} + +## Default Workflows + +{%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%} + +## How to get Started + +1. Explore **Default Workflows** within your Collate deployment to understand their structure and functionality. +2. Adjust configurations for the **Nodes** within these workflows to match your governance needs. +3. Contact our support team with any feedback, questions or suggestions! +4. Stay tuned for future updates that will introduce workflow creation and management capabilities. diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-check-entity-attributes.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-check-entity-attributes.png new file mode 100644 index 000000000000..617bc1a50063 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-check-entity-attributes.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-create-user-task.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-create-user-task.png new file mode 100644 index 000000000000..da5fdc303360 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-create-user-task.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-event-based-entity-trigger.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-event-based-entity-trigger.png new file mode 100644 index 000000000000..91cb4733d91d Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-event-based-entity-trigger.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-glossary-approval.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-glossary-approval.png new file mode 100644 index 000000000000..10ae9d0903b4 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-glossary-approval.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-configuration-page.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-configuration-page.png new file mode 100644 index 000000000000..d5a3fc35b0f5 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-configuration-page.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-configuration.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-configuration.png new file mode 100644 index 000000000000..bc775a41cda2 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-configuration.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-node-click.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-node-click.png new file mode 100644 index 000000000000..2ed36914c2ba Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-node-click.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-node-page.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-node-page.png new file mode 100644 index 000000000000..faf901e4a7ab Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-node-page.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-workflow.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-workflow.png new file mode 100644 index 000000000000..6126e6389123 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-how-to-edit-workflow.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-periodic-batch-entity-trigger.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-periodic-batch-entity-trigger.png new file mode 100644 index 000000000000..a34296150252 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-periodic-batch-entity-trigger.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-set-asset-certification.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-set-asset-certification.png new file mode 100644 index 000000000000..02d3e9ca4c42 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-set-asset-certification.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-set-glossary-term-status.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-set-glossary-term-status.png new file mode 100644 index 000000000000..1e90e96068e9 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-set-glossary-term-status.png differ diff --git a/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-table-certification.png b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-table-certification.png new file mode 100644 index 000000000000..fd8c341c1f96 Binary files /dev/null and b/openmetadata-docs/images/v1.6/how-to-guides/governance/workflows-table-certification.png differ