Workflow
Last updated
Last updated
An workflow is a structured sequence of steps and processes that govern the review and authorization of a task, document, or decision within an organization.
Click on the Create Workflow button.
This button is typically located at the top-right corner of the screen.
When you click it, the workflow creation interface will appear.
In this interface, you can define the approval steps, roles, notification preferences, and other relevant settings for your workflow.
Here is the approval workflow creation screen, where the user can give the flow a name and description.
Workflow Name
A flow name is like a short title for a process.
Description
The description is a quick explanation of what that process is all about.
What triggers this workflow?
On App Event: Triggers the flow when an event occurs in an authentication process, such as User Created, User Updated, User Deleted, etc.
On Webhook Call: Runs the flow when another app sends a webhook.
If You choose You will get the dropdown For choosing the event You can enable what you needed.
Add Step
Clicking the add level button will allow the user to create a new Step.
Step
"Step" refers to a specific access or permission tier within a system or platform.
Different levels might grant different privileges or permissions to users.
It's often used to categorize and control user access based on their roles or responsibilities.
Display Name:
The "Display Name" is the name that is shown to users and others within a system's interface or platform.
It's the name that represents a user, role, or resource in a human-readable format.
Display names are used to provide clarity and recognition, especially in user interfaces.
Description
The "Description" is a brief explanation or summary of what a particular item, role, or permission entails.
It's used to provide additional context to users, helping them understand the purpose or significance of a specific setting or feature.
Review In Progress Message
This customizable message is displayed to users when a workflow step is currently under review, indicating that the process is ongoing and awaiting further actions or decisions.
Node Type Selection
Allows selecting a predefined node type like Email Verification, Mobile Verification, User Role Assignment, or Custom. This enables configuring specific workflow steps directly on the same screen. Streamlines the process for setting up and managing workflow nodes efficiently.
For Email and Mobile Verification You will Get These two Fields
Verification Type: Specifies the verification method, allowing users to choose between direct link click or code entry. Adapts the process to align with user preferences for convenience.
Verification Timeout : Defines a time limit for completing the verification process, after which it expires. Ensures timely action by requiring re-initiation if the process remains incomplete.
Approvers By Groups & Roles
This feature allows you to assign approval responsibilities based on predefined groups and roles within the system.
Instead of specifying individual email addresses, you can assign approvals to entire groups of users or roles, streamlining the approval process.
Notify User on Approval
"Notify User on Approval" triggers a notification to the relevant user when the approver gives the approval.
This keeps users informed about the status of their submissions.
Notify User on Reject
Like the previous point, this feature notifies the user when their action or request has been rejected, providing transparency and information about the decision.
Approval Requirement Criteria The Approval Requirement Criteria field with options API and Manual refers to how a system handles the process of approval for a specific task, request, or action. The API option has the following fields
API Endpoint URL : The URL to which the system will send the API request for approval.
API Request Headers (Optional)
Additional key-value pairs for the API headers.
API Response Type*
Specifies whether the API provides an immediate (sync) or delayed (async) response.
Options:
Sync: The system waits for an immediate response from the API to proceed.
Async: The API sends a callback or updates the system later to provide the result.
For async this callback details will be shown
The Manual option has the following fields
Assign approvers
Approval Requirement Criteria : Specify the number of users required to approve the node: All users, Any one user, or Any N users, where 'N' represents a specific number of approvals needed.
Specify Approvers by Email : Give the Particular Approvers email the format will be shown below
Specify Approvers By Groups & Roles : You can also use the Group and Role for Specify the Approvers
When 'N' represents a You must provide the count.
On Approval (Enable Button - Template with Message)
Enabling the "On Approval" button empowers users to create the template with the predefined placeholder.
On Reject (Enable Button - Template with Message)
Enabling the "On Reject" button allows users to create the template with the predefined placeholder
On Approval Action:
"On Approval Action" refers to the actions that will be automatically taken once an approval is granted.
This could involve initiating a subsequent process, updating a record, or triggering certain workflows.
Groups & Roles for Approval:
This setting allows you to define which user groups or roles have the authority to approve specific actions or requests.
It streamlines the approval process by delegating decision-making to predefined groups.
Configure Approval Template:
"Configure Approval Template" involves setting up a standardized format for approvals with the predefined placeholders.
