-
Notifications
You must be signed in to change notification settings - Fork 2
QUA-993: Refactor " Flows" userguide. #851
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
Open
iammuze
wants to merge
12
commits into
main
Choose a base branch
from
qua-993-refactor-flow-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
5ef75fe
QUA:933- Refactor " Flows" userguide.
iammuze c6fb6e6
QUA-993: Update "Flow" userguide as per the latest release.
iammuze e88f17b
QUA-993: Update "flows" as per the suggestions.
iammuze 94a23a6
QUA-993: Update "Flows" Page.
iammuze 798bc36
QUA-993: Refactor Flows userguide as per the suggestions.
iammuze 2f6e5c6
QUA-993: Update "Flows" file as per the latest release.
iammuze e8fcdb2
QUA-993: Add "Abort Flow" feature as per the latest release.
iammuze dcc89b5
Resolved conflict — kept latest version from qua-993-refactor-flow-page
iammuze b5e48be
QUA-993: Update "Flows" userguide
iammuze e082e84
QUA-993: Update "Flows" userguide as per the suggestions.
iammuze c328376
Update "Flows" userguide.
iammuze 0ef3336
QUA-993: Update"Flows" document.
iammuze File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Abort Flow | ||
|
|
||
| Users can abort a flow that is currently triggered or running to stop further execution. | ||
|
|
||
| **Step 1:** Open the flow execution that is currently in progress and select the **settings** icon. | ||
|
|
||
|  | ||
|
|
||
| **Step 2:** Click on the **abort** to stop the execution. | ||
|
|
||
|  | ||
|
|
||
| A success message appears confirming the flow is aborted. | ||
|
|
||
| Alternatively, you can abort the flow from the Executions tab by clicking the **Abort** icon. | ||
|
|
||
|  |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # Activate Flow | ||
|
|
||
| Users can reactivate a flow that was previously deactivated. Once reactivated, the flow’s triggers become active again, allowing it to run automatically based on the defined conditions. | ||
|
|
||
| **Step 1**: Click the **vertical ellipsis (⋮)** next to the flow that you want to activate, then click on **Activate** from the dropdown menu. | ||
|
|
||
|  | ||
|
|
||
| After clicking the **Activate** button, a success notification appears confirming the activation. |
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Create a New Flow | ||
|
|
||
| Flows allow you to automate actions based on data operations, anomaly detection, or manual execution. When you create a new Flow, Qualytics automatically adds the base nodes you need to begin configuring the automation. | ||
|
|
||
| !!! note | ||
| To create a Flow, you must have **Manager** role. For more details, see the [Team Permissions guide](../settings/security/team-permissions.md){target="_blank"}. | ||
|
|
||
| **Step 1**: Click on the **Add Flow** button from the top right corner. | ||
|
|
||
|  | ||
|
|
||
| A modal window will appear, allowing you to create a new Flow. | ||
| Every Flow begins with two default nodes: | ||
|
|
||
| - **Flow Node** – Defines the Flow’s name, description, and activation state | ||
| - **Trigger Node** – Defines when the Flow will start | ||
|
|
||
|  | ||
|
|
||
| ## What You Configure Next | ||
|
|
||
| A Flow consists of three main node types. After creating a new Flow, you will configure each one: | ||
|
|
||
| ### **1. Flow Entry** | ||
|
|
||
| Defines the Flow’s general information such as its name and description. | ||
|
|
||
| !!! info | ||
| If you want to learn more about flow entry, check out the [Flow Entry](../flows/flow-entry.md) guide. | ||
|
|
||
| ### **2. Trigger Node** | ||
|
|
||
| Controls *when* the Flow starts (operation completes, anomaly detected, manual, etc.). | ||
|
|
||
| !!! info | ||
| For more detailed steps, you can review the [Trigger Node Documentation](../flows/trigger-node.md). | ||
|
|
||
| ### **3. Actions Node** | ||
|
|
||
| Defines *what happens* after the Flow is triggered (operations, notifications, HTTP calls, etc.). | ||
|
|
||
| !!! info | ||
| To explore this in more depth, take a look at the [Actions Node Documentation](../flows/overview-action.md). | ||
|
|
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Clone a Flow | ||
|
|
||
| Users can duplicate existing flows to simplify the reuse and modification of flow configurations for similar scenarios. | ||
|
|
||
| **Step 1**: Click on the existing flow you want to clone. | ||
|
|
||
|  | ||
|
|
||
| **Step 2**: A new window will open displaying the flow's detailed configuration. Click the settings icon and select **Clone**. | ||
|
|
||
|  | ||
|
|
||
| **Step 3:** After selecting the clone button, click the **Publish** button to publish it. | ||
|
|
||
|  | ||
|
|
||
| !!! important | ||
| Users with the **Manager Role** can create, edit, clone, or publish Flows. For details, see the [Team Permission ](../settings/security/team-permissions.md){target="_blank"}. | ||
|
|
||
| After clicking the **Publish** button, a success notification appears confirming that the flow has been successfully added. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Clone an Action | ||
|
|
||
| Users can duplicate an existing action in just a few clicks. Cloning an action allows you to quickly replicate its configuration without manually setting it up again. | ||
|
|
||
| **Step 1:** Click the vertical ellipsis (**⋮**) on the action you want to clone, then select the **Clone** option from the menu. | ||
|
|
||
| !!! info | ||
| You can add a maximum of **10 Operation** Actions (such as Catalog, Profile, or Scan) in a single flow. | ||
|
|
||
|  | ||
|
|
||
| **Step 2:** After clicking the Clone option, a cloned action will be created. | ||
|
|
||
|  |
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Deactivate Flow | ||
|
|
||
| Users can deactivate a flow to pause its triggers by disabling it. This prevents the flow from being executed until it is reactivated. | ||
|
|
||
| !!! info | ||
| To deactivate a Flow, you must have **Manager** role. Only users with this role can perform the deactivation action. | ||
| For more details about permissions, refer to the [permissions documentation](../settings/security/team-permissions.md){target="_blank"}. | ||
|
|
||
| **Step 1**: Click the **vertical ellipsis (⋮)** next to the flow that you want to deactivate, then click on **Deactivate** from the dropdown menu. | ||
|
|
||
|  | ||
|
|
||
| !!! note | ||
| If you accidentally deactivate a flow, you can easily reactivate it by following the steps in the [Activate Flow guide](../flows/activate-flow.md){target="_blank"}. | ||
|
|
||
| After clicking the **Deactivate** button, a success notification appears confirming the deactivation. | ||
|
|
||
| !!! warning | ||
| Deactivating a flow only pauses its triggers — not deletes it. You can reactivate it anytime, or see the [Delete Flow](../flows/delete-flow.md){target="_blank"} guide to remove it permanently. | ||
|
|
||
| ## FAQ | ||
|
|
||
| **1>.** What happens if I deactivate a Flow? | ||
|
|
||
| Once deactivated, the Flow’s triggers stop executing until you reactivate it. Existing executions will not be affected. |
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Delete Flow | ||
|
|
||
| **Delete Flow** feature allows you to permanently remove unwanted or outdated flows from the system. This helps in maintaining a clean and organized list of active flows. | ||
|
|
||
| !!! info | ||
| To delete a Flow, you must have **Manager** role. Only users with this role can perform the deletion action. | ||
| For more details about permissions, refer to the [permissions documentation](../settings/security/team-permissions.md){target="_blank"}. | ||
|
|
||
|
|
||
| **Step 1**: Click the **vertical ellipsis (⋮)** next to the flow that you want to delete, then click on **Delete** from the dropdown menu. | ||
|
|
||
|  | ||
|
|
||
| After clicking the delete button, a confirmation modal window **Delete Flow** will appear. | ||
|
|
||
|  | ||
|
|
||
| **Step 2**: Click on the **Delete** button to delete the flow. | ||
|
|
||
|  | ||
|
|
||
| After clicking the **Delete** button, a success notification appears confirming the deletion. | ||
|
|
||
| !!! warning | ||
| This action cannot be undone. If you only want to pause the flow instead of deleting it, see the [Deactivate Flow guide](../flows/deactivate-flow.md){target="_blank"}. |
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Edit Flow | ||
|
|
||
| **Edit Flow** feature lets users update existing flows by modifying configurations or adding actions. | ||
|
|
||
| !!! info | ||
| To edit a Flow, you must have **Manager** role. Only users with this role can perform the edit action. | ||
| For more details about permissions, refer to the [permissions documentation](../settings/security/team-permissions.md){target="_blank"}. | ||
|
|
||
| **Step 1:** Click the flow you want to edit. | ||
|
|
||
|  | ||
|
|
||
| **Step 2:** After clicking the flow, a new window will open displaying the flow's detailed configuration. Click on the boxes you want to edit. | ||
|
|
||
| For demonstration purposes we have selected the Flow node. | ||
|
|
||
|  | ||
|
|
||
| !!! tip | ||
| If you make changes that you don’t want to keep, you can undo them by discarding the unsaved configuration or refreshing the page before publishing. | ||
|
|
||
| **Step 3:** Click the **`Save`** button to apply the updates. | ||
|
|
||
|  | ||
|
|
||
| **Step 4:** After clicking the **`Save`** button, click the **`Publish`** button located in the top right corner to finalize and publish the changes. | ||
|
|
||
| !!! warning | ||
| If the flow is not published, the setup will not be saved. Always publish the flow after editing to ensure your changes are retained. | ||
|
|
||
|  |
RafaelOsiro marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Execute Manual Flows | ||
|
|
||
| Manual execution gives you complete control over when a Flow should run. You can start a manual Flow directly from the Flows list or from inside the Flow editor. | ||
|
|
||
| ## Method 1: Execute From the Flows List | ||
|
|
||
| **Step 1:** Locate the manual flow in your list of flows. | ||
|
|
||
|  | ||
|
|
||
| **Step 2:** Click the **vertical ellipsis (⋮)** next to the manual flow you wish to execute, then select **"Execute"** from the dropdown menu to trigger the flow. | ||
|
|
||
|  | ||
|
|
||
| After clicking the **Execute** button, a success notification appears confirming that the flow has been successfully executed. | ||
|
|
||
| ## Method 2: Execute From Inside the Flow Editor | ||
|
|
||
| You can also run a manual Flow directly from its editor page. | ||
|
|
||
| **Step 1:** Click on the manual flow in your list to open it. | ||
|
|
||
|  | ||
|
|
||
| **Step 2:** You will be navigated to the Flow editor page; click the **Execute** button. | ||
|
|
||
|  | ||
|
|
||
| After clicking the **Execute** button, a success notification appears confirming that the flow has been successfully executed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Flow Entry | ||
|
|
||
| The **Flow Entry** is the starting point of every Flow in Qualytics. Think of it as the “root” of your automation — it defines the Flow’s name, purpose, and whether it is active. Once this node is set, you can continue building the rest of the Flow (Triggers, Actions, etc.). | ||
|
|
||
| ## Trigger Types | ||
|
|
||
| A Flow begins when one of its Triggers activates. Here are the four available trigger types: | ||
|
|
||
| | Trigger Type | Description | | ||
| |--------------|-------------| | ||
| | [**Operation Completes**](../flows/trigger-node.md#operation-completes){target="_blank"} | Starts the Flow when a catalog, scan, or profile operation finishes. | | ||
| | [**Anomalous Table & File Detected**](../flows/trigger-node.md#anomalous-table-and-file-detected){target="_blank"} | Starts the Flow when anomalies are detected in a table or file. | | ||
| | [**Anomaly Detected**](../flows/trigger-node.md#anomaly-detected){target="_blank"} | Starts the Flow when a single anomaly event occurs. | | ||
| | [**Manual**](../flows/trigger-node.md#manual){target="_blank"} | Starts the Flow only when the user manually executes it. | | ||
|
|
||
| ## Configure the Flow Node | ||
|
|
||
| **Step 1:** Click on the **Flow** node. | ||
|
|
||
|  | ||
|
|
||
| A panel will appear on the right-hand side, allowing you to: | ||
|
|
||
| | No. | Field Name | Description | | ||
| | :---- | :---- | :---- | | ||
| | 1. | **Name** | Enter the name for the flow. | | ||
| | 2. | **Description** | Provide a brief description of the flow (optional) to clarify its purpose or functionality. | | ||
| | 3. | **Deactivated** | Check the box to deactivate the flow. If selected, the flow won't start even if the trigger conditions are met. | | ||
|
|
||
|  | ||
|
|
||
| **Step 2:** Once the details are filled in, click the **Save** button to save the flow settings. | ||
|
|
||
|  |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.