-
Notifications
You must be signed in to change notification settings - Fork 362
Add workflow docs #5493
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
Add workflow docs #5493
Changes from all commits
54f9873
e79da01
d42bd9e
b171c59
eadebd2
a5f095b
52c7d68
806dbf5
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/user-self-service/manage-approvals.md" %} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "../../../../includes/guides/workflows/approve-workflow.md" %} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "../../../../includes/guides/workflows/index.md" %} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "../../../../includes/guides/workflows/workflow-requests.md" %} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "../../../../../includes/guides/user-self-service/manage-approvals.md" %} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "../../../../../includes/guides/workflows/approve-workflow.md" %} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "../../../../../includes/guides/workflows/index.md" %} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {% include "../../../../../includes/guides/workflows/workflow-requests.md" %} |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| 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. | ||
|
|
||
| {: 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
|
||
|
|
||
| This page shows all the approvals available for the user to approve. | ||
|
|
||
| Learn more about the approvals and its lifecycle in the [Approvals]({{base_path}}/guides/workflows/approve-workflow/) guide. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| To view the workflow approvals, you need to navigate to the **Approvals** page under the **User Management** in the admin console or in the [My Account]({{base_path}}/guides/user-self-service/manage-approvals/). There, you will see a list of approvals that you can approve. | ||
|
Check warning on line 1 in en/includes/guides/workflows/approve-workflow.md
|
||
|
|
||
| {: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
|
Check warning on line 3 in en/includes/guides/workflows/approve-workflow.md
|
||
|
|
||
| ### Approval lifecycle | ||
|
|
||
| Approval lifecycle contains several states: | ||
|
|
||
| - **Reserved**: You have claimed(assigned) the approval, so no one else can approve it until you either approve or release it. | ||
| - **Ready**: You can approve this request. This status appears when no one has claimed it yet. | ||
| - **Approved**: You have approved the request. | ||
| - **Rejected**: You have rejected the request. | ||
| - **Blocked**: Another participant has claimed the approval, so you can’t act on it. | ||
|
|
||
| !!! Note | ||
| Claiming an approval lets you assign it to yourself. Once you claim an approval, no one else can approve it. This helps ensure that only you approve the request. | ||
|
|
||
| Also note that even if you claim an approval, you can still release it back to the pool of approvals so that other participants can approve it. | ||
|
|
||
| ### View approval details | ||
|
|
||
| To view the details of an approval, you can click on the approval in the list. This will open the approval details page where you can see the details of the approval related to the operation. | ||
|
|
||
| {: 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,36 @@ | ||
| Workflows are a series of steps that require to complete a selected operation in the {{ product_name }}. These workflows | ||
| should be configured by the administrators by defining the steps and the participants involved in each step. | ||
|
|
||
| ### 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 | ||
Malith-19 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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. | ||
Malith-19 marked this conversation as resolved.
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. | ||
|
|
||
| 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. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| Workflow request page is located under the workflows section. It gives administrators full visibility into every workflow approval request across the tenant. | ||
Malith-19 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Administrators can use it to audit progress, and detect bottlenecks. | ||
|
|
||
| {: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
|
|
||
| This page lists all the workflow requests that are the tenant. You can filter the requests by the Operation Type, Status, Created Time Range and Updated Time Range. | ||
|
|
||
| ### Status of the workflow requests | ||
|
|
||
| - **Pending**: The workflow request is pending and waiting for approval. | ||
| - **Approved**: The workflow request is approved by the participant/s. | ||
| - **Rejected**: The workflow request is rejected by a participant. | ||
| - **Failed**: The workflow request has failed after the approval due to an error. | ||
| - **Deleted**: The workflow request has been deleted by the administrator. | ||
|
|
||
| ### View workflow request details | ||
|
|
||
| To view the details of a workflow request, you can click on the request in the list. | ||
|
|
||
| {: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"} | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These were not changed by this PR and Vale detects all the issues in a changed file. Do we still need to fix this via my changes?