Use case Description
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
This use case describes the implementation of REST services to allow users to download various types of files (Input file, Output file, Dropped record file, Error file, Duplicate record file) from the database. These services will be mapped to the user interface, enabling users to perform these tasks directly from the front end. |
Actors:
User
Backend Server
Database (Solution DB)
UI (Web Form)
Preconditions:
Files (Input, Output, Dropped record, Error, Duplicate record) are stored in the Solution DB.
RESTful API is set up on the backend server.
UI supports interaction with the REST services for file downloads.
Postconditions:
Users can download the specified files directly from the UI.
The requested files are retrieved from the database and provided to the user for download.
Steps:
1. Design Process flow
Overview
Backend Service for Download Input file, V3 Target File, Combined Error Report, Unsupported Product Code Report, and Account Structure Report.
Process Overview
This process flow service, supported by a structured process, retrieves all input file attachments and output and error reports.
The flow contains data formatted in JSON using ContextTarget, which the REST provider API will call. This API is consumed in the UI and functions as a backend service for the UI.
Process Flow :
...
Once the flow has been designed, it must be published for the REST provider.
...
Front-End Interface:
...
a. Default Flow: To Download Input File Attachment
Process Overview
The Process flow is designed to manage input file requests, allowing users to download file files from the User Interface (UI). This flow functions as a backend service for the REST provider API. When a user triggers the API, this flow is invoked to handle the request.
Process flow:
...
User Interface:
...
Process Steps
User Initiates File Download Request
...
Action: The UI processes the response and initiates the file download for the user.
Result: User receives the requested input file.
...
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. Flow to Download the Output & Error Reports File:
Process Overview
The Process flow is designed to manage output & error report file requests, allowing users to download output & error report files from the User Interface (UI). This flow functions as a backend service for the REST provider API. When a user triggers the API, this flow is invoked to handle the request.
Process Flow:
...
FrondEnd:
...
Process Steps
User Initiates File Download Request
...
Action: The UI processes the response and initiates the file download for the user.
Result: User receives the requested input file.
...
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.
...
2. Create REST Provider End-point
In this particular use case, the process flow is shared by developing a REST provider that will eventually be integrated with the user interface.
...
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
...