Processes
What are Processes?
Processes enable the background execution of tasks that require more than few seconds to complete, allowing users to keep using the system while the processes complete. Processes are particularly effective when performing long-running tasks like sending multiple emails or merging documents in bulk.
Currently, processes are used to perform the following actions:
Sending SMS to multiple records.
Sending Emails to multiple records.
Merging Documents for multiple records.
Exporting large dataset from grids.
How Processes Work
When users initiate a task that might take longer than few seconds to complete, a process is automatically created. Each process provides users with detailed information, including current status, created/completed date and times, detailed logs and any potential errors or warnings.
Once the process is completed, notifications will be sent to the user who initiated the task. If the task resulted with the generation of a file, users will can download it from the process details page.
A summary of the processes flow is explained below:
![image-20240213-025817.png](../../../__attachments/790757872/image-20240213-025817.png?inst-v=98d15ec2-0529-4904-9367-f860e216aac1)
Task Started (process trigger): When a task is started by a user, eBECAS/EDMISS NextGen creates and starts a Processes to handle this task. Users will receive a notification indicating that a process has been created to complete the task.
Process Initiated: A process is initiated to perform the task. While the process works on the task, users are free to continue using the system.
Process Completed: When the process is completed, the process details are updated and available on the process details page.
Get Notification: Users will be notified that the process has finished. Users can go to the process details page to view the results of the process.
Processes Statuses
A process go through multiple steps, from its initial request to potential completion or failure. The following are the statuses a process goes through:
Requested: This is the first status of a process when it is requested by a user action.
Queued: When the process is requested and the engine accepts the request, it is put in a queue to be processed.
Started: Once the engine takes the process from the queue, the status transitions to Started.
Completed: Once the engine finishes the process, the status transitions to Completed. A completed task might have some warning or errors. The details will be in the process logs.
Failed: A process that cannot be completed due to errors transition to the Failed status. The details will be in the process logs.
Processes Types
The following are the types of processes currently available in the app:
Merge: Processes from generating documents using the Merging Documents feature.
Export Data: Processes from exporting data from the data grids.
Send Message: Processes from sending SMS or Email messages.
View My Processes
Follow these step to access your processes:
Unless given additional permissions, users can only see their own processes. See the section Access All Processes below for more details.
Processes and their associated fields are automatically deleted on a regular basis, with the retention period depending on your subscription plan. Please contact your system administrator for more details.
Click on your name and then on My Processes in the header of the app.
You will see filters and a data grid with all your processes. The filters available are:
Created From/To: Filters the processes based on the Creation date.
Status: Filter the processes based on their current Status.
Type: Filter the processes based on their Type.
Description: Filter the processes that contain the entered value in the Description.
Object: Filter the processes based on the object that the process was created for.
To see the details of a process, click on the Id of the process.
View All Processes (organisation-wide)
Users with the appropriate permissions can view the processes for all the users in the organisation:
From the Utilities Menu, go to Processes.
You will see filters and a data grid with all your processes for all users.
Process Details
To view the details for a specific process:
Click on the ID of the desired process from either My Processes or All Processes grids.
The details for the process are displayed:
Process Type: This section displays the process’ type.
Process Basic Details: It displays a brief overview of the process' information.
Process Description: This is the description of the process.
File: If the process results in a generation of a file (e.g. merging documents) you can download the file by clicking on the Download File button.
Logs: You can check the results of the operations performed on each individual record. If any steps on the process fails, you can check the details here.
[Example] Process completed with failed subtasks