Skip to content

Commit d42bd9e

Browse files
committed
Address the comments.
1 parent e79da01 commit d42bd9e

File tree

9 files changed

+28
-26
lines changed

9 files changed

+28
-26
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{% include "../../../../includes/guides/workflows/approve-workflow.md" %}
1+
{% include "../../../../includes/guides/workflows/approve-workflow.md" %}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{% include "../../../../includes/guides/workflows/index.md" %}
1+
{% include "../../../../includes/guides/workflows/index.md" %}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{% include "../../../../includes/guides/workflows/workflow-requests.md" %}
1+
{% include "../../../../includes/guides/workflows/workflow-requests.md" %}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{% include "../../../../../includes/guides/workflows/approve-workflow.md" %}
1+
{% include "../../../../../includes/guides/workflows/approve-workflow.md" %}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{% include "../../../../../includes/guides/workflows/index.md" %}
1+
{% include "../../../../../includes/guides/workflows/index.md" %}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{% include "../../../../../includes/guides/workflows/workflow-requests.md" %}
1+
{% include "../../../../../includes/guides/workflows/workflow-requests.md" %}
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
To view the workflow approvals, you need to navigate to the **Approvals** page under the **User Management** in the admin console. Here, you will see a list of approvals that can be approved by you.
1+
To view the workflow approvals, you need to navigate to the **Approvals** page under the **User Management** in the admin console. There, you will see a list of approvals that you can approve.
22

33
![Workflow approval page]({{base_path}}/assets/img/guides/workflows/workflow-approvals.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
44

55
### Approval lifecycle
6-
There are multiple status indicators for the workflow approvals. The status of the approval can be one of the following:
76

8-
- **Reserved**: The approval is reserved by you and no one else can approve it. This status is set when you claim the approval.
9-
- **Ready**: The approval is ready to be approved by you. This status is set when multiple participants are involved in the approval step and no one has claimed the approval yet.
10-
- **Approved**: The approval is approved by you.
11-
- **Rejected**: The approval is rejected by you.
12-
- **Blocked**: The approval has claimed by another participant and you cannot approve it.
7+
Approval lifecycle contains several states:
8+
9+
- **Reserved**: You have claimed(assigned) the approval, so no one else can approve it until you either approve or release it.
10+
- **Ready**: You can approve this request. This status appears when no one has claimed it yet.
11+
- **Approved**: You have approved the request.
12+
- **Rejected**: You have rejected the request.
13+
- **Blocked**: Another participant has claimed the approval, so you can’t act on it.
1314

1415
!!! Note
15-
Claiming an approval is a way to assign it for yourself. If you claim an approval, no one else can approve it until you either approve or reject it. This is useful when you want to ensure that you are the only one approving the request.
16+
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.
1617

1718
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.
1819

1920
### View approval details
21+
2022
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.
2123

22-
![Approval details]({{base_path}}/assets/img/guides/workflows/approval-details.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
24+
![Approval details]({{base_path}}/assets/img/guides/workflows/approval-details.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
1-
Workflows are series of steps that require to complete a selected operation in the {{ product_name }}. These workflows
1+
Workflows are a series of steps that require to complete a selected operation in the {{ product_name }}. These workflows
22
should be configured by the administrators by defining the steps and the participants involved in each step.
33

44
### Create a workflow
5+
56
To create a workflow, visit the **Workflows** section in the admin console and go to the **Approval Workflows** section.
67
Now you can create a new workflow by clicking on the **New Approval Workflow** button. You will be prompted to provide a
78
name and description for the workflow.
89

910
### Configure workflow operations
11+
1012
Once you have provided the name and description, you can select the operations that this workflow should support.
1113
The workflows are supported following types of operations:
1214

1315
- **User Creation**: Triggered when a new user is created.
1416
- **User Deletion**: Triggered when a user is deleted.
1517
- **Role Creation**: Triggered when a new role is created.
16-
- **User Role Assignment**: Triggered when a users of a role has changed.
18+
- **User Role Assignment**: Triggered when users of a role have changed.
1719

1820
!!! note
19-
In the workflow creation page, you can select the multiple operations if approval steps are common for those operations.
21+
In the workflow creation page, you can select multiple operations if approval steps are common for those operations.
2022

2123
### Configure workflow steps
22-
The final configuration of the workflow creation is to configure the steps of the workflow. You can add multiple steps to a workflow and
23-
each step can have multiple participants. The participants can be either users or roles.
24+
25+
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.
2426

2527
![Workflow steps configuration]({{base_path}}/assets/img/guides/workflows/workflow-steps-configuration.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
2628

@@ -30,7 +32,5 @@ Once you have configured the steps, you can save the workflow. The workflow will
3032
If you assign admin user in the first step of approval and if admin creates a user, still workflow will be triggered.
3133
And also other participants of the first step will also receive the approval request.
3234

33-
34-
Once the workflow is created, you can view the details of the workflow, edit it or delete it.
35+
Once the workflow is created, you can view the details of the workflow, edit it or delete it.
3536
To approve the workflow, you need to go the approvals section under the User Management. See [Approve a workflow]({{base_path}}/guides/workflows/approve-workflow/) for more information on how to approve a workflow.
36-

en/includes/guides/workflows/workflow-requests.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@ Administrators can use it to audit progress, and detect bottlenecks.
33

44
![Workflow request page]({{base_path}}/assets/img/guides/workflows/workflow-requests.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
55

6-
This page list all the workflow requests that in the tenant. You can filter the requests by the Operation Type, Status, Created Time Range and Updated Time Range.
6+
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.
77

88
### Status of the workflow requests
99

1010
- **Pending**: The workflow request is pending and waiting for approval.
1111
- **Approved**: The workflow request is approved by the participant/s.
1212
- **Rejected**: The workflow request is rejected by a participant.
13-
- **Falied**: The workflow request has failed after the approval due to an error.
13+
- **Failed**: The workflow request has failed after the approval due to an error.
1414
- **Deleted**: The workflow request has been deleted by the administrator.
1515

1616
### View workflow request details
17+
1718
To view the details of a workflow request, you can click on the request in the list.
1819

1920
![Workflow request page]({{base_path}}/assets/img/guides/workflows/workflow-request-details.png){: width="800" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
20-

0 commit comments

Comments
 (0)