- 
                Notifications
    You must be signed in to change notification settings 
- Fork 360
Update workflow docs with latest changes #5643
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
Changes from 1 commit
907e1f9
              a705637
              71aa0c5
              3179f43
              048db30
              File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "../../../../includes/guides/workflows/approval-workflows.md" %} | 
This file was deleted.
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "../../../../../includes/guides/workflows/approval-workflows.md" %} | 
This file was deleted.
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -1,9 +1,31 @@ | ||
| Using the My Account Portal, users can view and update their approvals. This allows users to manage their pending requests and actions that require their attention. | ||
|  | ||
| To view the approvals, user can navigate to the **Approvals** section from the My Account Portal side menu. | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
|  | ||
| {: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
| This page displays all approval requests that you are eligible to act on. | ||
| Check warning on line 3 in en/includes/guides/user-self-service/manage-approvals.md 
     | ||
|  | ||
| {: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
| Check warning on line 5 in en/includes/guides/user-self-service/manage-approvals.md 
     | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Show resolved
            Hide resolved | ||
|  | ||
| ### Approval states | ||
|  | ||
| Each approval request can be in one of the following states: | ||
| Check warning on line 9 in en/includes/guides/user-self-service/manage-approvals.md 
     | ||
|  | ||
| - **Ready**: The approval request is available for assignment. You can either approve it immediately or reserve it for review later. | ||
| Check warning on line 11 in en/includes/guides/user-self-service/manage-approvals.md 
     | ||
| - **Reserved**: You have assigned yourself this approval for review. Other approvers cannot act on it until you unassign it. | ||
| Check warning on line 12 in en/includes/guides/user-self-service/manage-approvals.md 
     | ||
| - **Blocked**: Another approver has already reserved this request, so you cannot act on it. | ||
| Check failure on line 13 in en/includes/guides/user-self-service/manage-approvals.md 
     | ||
| - **Approved**: You have approved the request. | ||
| - **Rejected**: You have rejected the request. | ||
|  | ||
| !!! Note | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
| Once you reserve (assign yourself) an approval, no one else can approve it. However, you can unassign a reserved approval back to the shared pool at any time, allowing other eligible approvers to act on it. | ||
| Check warning on line 18 in en/includes/guides/user-self-service/manage-approvals.md 
     | ||
|  | ||
| {: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
|  | ||
| You can filter approval requests based on their state, as shown below. | ||
|  | ||
| {: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
|  | ||
| ### View approval details | ||
|  | ||
| This page shows all the approvals available for the user to approve. | ||
| To view more information about a specific approval, click on the approval entry in the list. | ||
| This opens the Approval Details page, which displays all relevant information about the associated operation. | ||
|  | ||
| Learn more about the approvals and its lifecycle in the [Approvals]({{base_path}}/guides/workflows/approve-workflow/) guide. | ||
| {: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| ### Create a workflow | ||
|  | ||
| To create a workflow, visit the **Workflows** section in the admin console and go to the **Approval Workflows** section. | ||
| Now you can create a new workflow by clicking on the **New Approval Workflow** button. You will be prompted to provide a | ||
| name and description for the workflow. | ||
|  | ||
| ### Configure workflow operations | ||
|  | ||
| Once you have provided the name and description, you can select the operations that this workflow should support. | ||
| The workflows are supported following types of operations: | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
|  | ||
| - **User Creation**: Triggered when a new user is created. | ||
| - **Self User Registration**: Triggered when a new user is self registered. | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
| - **User Deletion**: Triggered when a user is deleted. | ||
| - **Role Creation**: Triggered when a new role is created. | ||
| - **User Role Assignment**: Triggered when users of a role have changed. | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
|  | ||
| !!! note | ||
| In the workflow creation page, you can select multiple operations if approval steps are common for those operations. | ||
|  | ||
| ### Configure workflow steps | ||
|  | ||
| The final configuration of the workflow creation is to configure the steps of the workflow. You can add multiple steps to a workflow and each step can have multiple approvers. The approvers can be belongs to a configured role or defined users. | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
|  | ||
| {: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
|  | ||
| Once you have configured the steps, you can save the workflow. The workflow will now be available for use in the system. | ||
|  | ||
| !!! note | ||
| If you assign admin user in the first step of approval and if admin creates a user, still workflow will be triggered. | ||
| And also other participants of the first step will also receive the approval request. | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
|  | ||
| After creating the workflow, you can view its details, edit it, or delete it. | ||
|  | ||
| {: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
|  | ||
| To learn how to review the approval requests, see [Manage Approvals]({{base_path}}/guides/user-self-service/manage-approvals/). | ||
This file was deleted.
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -1,48 +1,19 @@ | ||
| Revamped workflow-based approval framework designed to support long-running approval workflows for critical user | ||
| management operations. | ||
| The new workflow framework designed to support long-running approval workflows for critical user management operations. | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
|  | ||
| Workflows are a series of steps that require to complete a selected operation in the {{ product_name }}. These workflows | ||
|         
                  sadilchamishka marked this conversation as resolved.
              Outdated
          
            Show resolved
            Hide resolved | ||
| should be configured by the administrators by defining the steps and the participants involved in each step. | ||
|  | ||
| This new implementation enables organizations to design multi-step approval chains, where approvers can be assigned | ||
| based on roles or groups, reflecting their permission levels and responsibilities. Administrators can configure these | ||
| workflows through the Console, while users can review and act on approval requests seamlessly from the My Account portal. | ||
|  | ||
| !!! note | ||
| This is a reimplementation of the previous workflow feature. It is not backward compatible with the older workflow | ||
| configurations. Existing workflows must be redefined using the new model to take advantage of long-running approval | ||
| capabilities. | ||
|  | ||
| ### Create a workflow | ||
|  | ||
| To create a workflow, visit the **Workflows** section in the admin console and go to the **Approval Workflows** section. | ||
| Now you can create a new workflow by clicking on the **New Approval Workflow** button. You will be prompted to provide a | ||
| name and description for the workflow. | ||
|  | ||
| ### Configure workflow operations | ||
|  | ||
| Once you have provided the name and description, you can select the operations that this workflow should support. | ||
| The workflows are supported following types of operations: | ||
|  | ||
| - **User Creation**: Triggered when a new user is created. | ||
| - **User Deletion**: Triggered when a user is deleted. | ||
| - **Role Creation**: Triggered when a new role is created. | ||
| - **User Role Assignment**: Triggered when users of a role have changed. | ||
|  | ||
| !!! note | ||
| In the workflow creation page, you can select multiple operations if approval steps are common for those operations. | ||
|  | ||
| ### Configure workflow steps | ||
|  | ||
| The final configuration of the workflow creation is to configure the steps of the workflow. You can add multiple steps to a workflow and each step can have multiple participants. The participants can be either users or roles. | ||
|  | ||
| {: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
|  | ||
| Once you have configured the steps, you can save the workflow. The workflow will now be available for use in the system. | ||
|  | ||
| !!! note | ||
| If you assign admin user in the first step of approval and if admin creates a user, still workflow will be triggered. | ||
| And also other participants of the first step will also receive the approval request. | ||
|  | ||
| Once the workflow is created, you can view the details of the workflow, edit it or delete it. | ||
| To approve the workflow, you need to go the approvals section under the User Management in the console or use my account approvals. See [Approve a workflow]({{base_path}}/guides/workflows/approve-workflow/) for more information on how to approve a workflow. | ||
| should be configured by the administrators by defining the steps and the approvers involved in each step. | ||
|  | ||
| This new implementation enables organizations to design multi-step approval processes, where approvers can be assigned | ||
| Check failure on line 6 in en/includes/guides/workflows/index.md 
     | ||
| based on roles or users, reflecting their permission levels and responsibilities. Administrators can configure these | ||
| Check failure on line 7 in en/includes/guides/workflows/index.md 
     | ||
| workflows through the Console, while approvers can review and act on approval requests seamlessly from the My Account portal. | ||
|  | ||
| {% if product_name == "WSO2 Identity Server" %} | ||
| !!! note "Legacy BPS-based workflow connector" | ||
| {{ product_name }} previously used a BPS (Business Process Server)-based approval workflow implementation. This implementation is still available as an [external connector](https://store.wso2.com/connector/identity-workflow-impl-bps){:target="_blank"}. | ||
|  | ||
| Check failure on line 13 in en/includes/guides/workflows/index.md 
     | ||
| **Key differences:** | ||
|  | ||
| - The new workflow feature and the BPS-based implementation run independently. | ||
| - Approval requests from the new workflow feature appear in **My Account** for review. | ||
| - Approval requests from the BPS-based implementation remain accessible via the legacy approval API. | ||
| {% endif %} | ||
| Check failure on line 19 in en/includes/guides/workflows/index.md 
     | ||
Uh oh!
There was an error while loading. Please reload this page.