...
Use case Description
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Backend Services to search data in file queues, Advanced search data based on Start Date and End Date in flex queues, and Solution tables having pagination support and Solution tablesThis use case outlines the procedure for retrieving data from relational tables in a database by executing a DB query within an Adeptia process flow. The retrieved information is then presented on a web form reflecting data from the past 30 days. This process includes establishing a REST provider endpoint that triggers the execution of the process flow incorporating the DB query. |
Actors:
User
Backend Server
Adeptia Process Flow
Database (Solution DB)
Preconditions:
Data is stored in multiple relational tables within the Solution DB.
Adeptia process flow is configured to execute DB queries.
REST provider endpoint is created and accessible.
UI (web form) is ready to display the fetched data.
Postconditions:
Relevant data is successfully retrieved from the database.
Data is displayed on the web form for the user.
Steps:
1. Design Process flow
Overview
When the file queue page is accessed, the backend server performs specific steps to ensure that all relevant file queue data is accurately retrieved and displayed on the front end. There are three primary flows, each with a distinct purpose. Once designed, these flows need to be published for the REST provider.
Process Overview
When the file queue page is accessed, the backend server performs the following steps to ensure that all relevant file queue data is accurately retrieved and displayed on the front end. Here are three flows working and each flow has a purpose.
Once the flow has been designed, it must be published for the REST provider.
...
a. Default Flow: Retrieve All File Information For the Last 30 days
...
This process will extract all file information from the last 30 days.
...
Process Steps
Step 1: Receive Request
Action: The backend server receives a request from the frontend to access the file queue page.
Trigger: Initiates the process of retrieving necessary file queue data.
...
Action: The backend sends the retrieved data to the front end.
Outcome: The front end displays the data, providing users with a comprehensive view of the file queue status and details.
...
Process flow activity:
Source Activity - The source comprises a database. It is necessary to create DbInfo and DbLayout to be invoked in the source activity
...
Context Target Using ContextTarget to store data in the flow which will be carried by the REST provider.
...
b.Search Flow: Search by Filename & Transaction Id
This flow process is for searching specific file information within the system. It enables how the user initiates the search, the interactions between the front end and back end, and the final display of the filtered results to the user.
...
Process Overview
The search process for file information involves several key steps, starting from user initiation to the final display of search results. The following sections detail each step in the process.
Process Steps
Step 1: User Initiates Search
Action: The user initiates a search for specific file information.
Interface: The search is conducted using a search bar or input field on the file queue page or a dedicated search interface.
...
Step 2: Frontend Sends Request
Action: The frontend application captures the user's search query.
Request: The search query is encapsulated in a request and sent to the backend server for processing.
Data Sent: The request typically includes the search term(s) and any additional filters or parameters specified by the user.
Step 3: Backend Searches File Queue Data
Action: Upon receiving the request, the backend server initiates a search operation.
Database Query: The backend performs a query on the file queue data, searching for records that match the search query.
Search Criteria: The search operation may include matching filenames, dates, statuses, or other relevant metadata associated with the files.
Step 4: Backend Returns Filtered Results
Action: The backend processes the query results and filters out the relevant records.
Response: The filtered search results are then encapsulated in a response.
Data Returned: The response includes all relevant records that match the search criteria, formatted for easy consumption by the front end.
Step 5: Frontend Displays Results
Action: The front end receives the response from the backend.
Display: The filtered search results are displayed to the user clearly and organized.
User Interface: The results can be displayed in a list, table, or any other suitable format, allowing the user to browse and analyze the information easily.
Process flow activity:
Source Activity: The source comprises a database. It is necessary to create DbInfo and DbLayout to be invoked in the source activity
...
Context Target -The target will be ContextTarget to store data in the flow for the REST provider.
...
c. Advanced Process Flow - Filtering Records by (Start Date & End Date)
...
Overview
This Process flow is used for advanced search in which a user can filter records based on their start date and end date using the Advanced Search functionality. This includes the interactions between the frontend and backend systems to accomplish this task.
Process Steps
1. Date Range Selection
User Action:
The user selects a date range or enters specific dates to filter records by the created date.
UI Elements:
Date pickers for selecting the start and end dates.
A button to submit the filter request.
2. Request Submission
Frontend Action:
The frontend constructs a request with the selected date range like
Start Date&End Date
...
3. Date Filter
Backend Action:
The backend processes the request by filtering the file queue data based on the provided date range.
Implementation:
The backend queries the database to retrieve records where the
createdDatefalls within thestartDateandendDate.
4. Response Handling
Backend Action:
The backend returns the filtered results to the front end.
5. Display Results
Frontend Action:
The front end processes the response and displays the filtered results to the user.
UI Elements:
A table view to present the filtered file records.
The results section updates dynamically upon receiving the response.
...
Process flow activity:
Source Activity - The source comprises a database. It is necessary to create DbInfo and DbLayout to be invoked in the source activity
...
Context Target -The target will be ContextTarget to store data in the flow for the REST provider.
...
2. Create REST Provider End-point
Overview
A REST (Representational State Transfer) Provider is a service that offers resources and functionalities over HTTP(S) using standard REST principles. It enables clients to interact with the service through predefined APIs, facilitating the integration and communication between different systems.
...
Select the Response Schema (For example, we are opting for the schema that has been utilized in the process flow as the target schema)
...
Save it.
3. Publish the Provider (REST URL) at UI
Once the above steps have been completed, it is necessary to link the REST provider URL with the user interface (UI) to present the data on the UI
...