REST Services for Downloading Input, Output, Dropped Record, Error, and Duplicate Record Files from Database

Use case Description

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 :

Open

Once the flow has been designed, it must be published for the REST provider.

Open

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

1. User Initiates File Download Request

• Action: User interacts with the User Interface (UI) to request an input file download.

• Trigger: User clicks the download button or selects the download option.

2. UI Sends Request to REST Provider API

• Action: The UI sends an HTTP request to the REST provider API endpoint.

• HTTP Method: GET

3. REST Provider API Calls Default Flow

• Action: The REST provider API receives the request and invokes the default flow to handle the file retrieval process.

• Process: The API calls the backend service associated with the default flow.

4. Backend Service Retrieves Input File Attachment

• Action: The backend service retrieves the specified input file attachment from the server or database.

• File Types: Input file V3, Target File Combined Error Report, Unsupported Product Code Report, Account Structure Report.

5. Backend Service Returns File to REST Provider API

• Action: The backend service sends data back to the REST provider API.

6. REST Provider API Sends Response to UI

• Action: The REST provider API sends the response containing the file data back to the UI.

7. UI Processes and Provides File Download to User

• Action: The UI processes the response and initiates the file download for the user.

• Result: User receives the requested input file.

Process flow Activity:

1. Source Activity - The source comprises a database. It is necessary to create DbInfo and DbLayout to be invoked in the source activity

Go to edit query and to write tables joining query.

Query Details:

Table Name: DB/file_queueFQ/

2. Stream Selector - Use the Steam selector to specify the input stream to be consumed by the activity when there are two sources (DB).

3. Target Layout - The JSON schema for the source data (database) will be designed to be utilized in the RESTful API for the user interface. JSON is selected for its compatibility with RESTful APIs.

4. Mapping - Load the database schema and the target schema (JSON) to do one-to-one mapping.

   1. Apply the foreach loop to fetch the data one by one.

5. 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

1. User Initiates File Download Request

• Action: User interacts with the User Interface (UI) to request an Output & Error Report file download.

• Trigger: User clicks the download button or selects the download option.

1. UI Sends Request to REST Provider API

• Action: The UI sends an HTTP request to the REST provider API endpoint.

• HTTP Method: GET

2. REST Provider API Calls Default Flow

• Action: The REST provider API receives the request and invokes the default flow to handle the file retrieval process.

• Process: The API calls the backend service associated with the default flow.

3. Backend Service Retrieves Input File Attachment

• Action: The backend service retrieves the specified input file attachment from the server or database.

• File Types: v3 Output file, EBMR output file, Dropped record file, Error file, Filtered product list, Dropped record, DBQUERY_FILE

4. Backend Service Returns File to REST Provider API

• Action: The backend service sends data back to the REST provider API.

5. REST Provider API Sends Response to UI

• Action: The REST provider API sends the response containing the file data back to the UI.

6. UI Processes and Provides File Download to User

• Action: The UI processes the response and initiates the file download for the user.

• Result: User receives the requested input file.

Process flow Activity:

1. Source Activity - The source comprises a database. It is necessary to create DbInfo and DbLayout to be invoked in the source activity.

Go to edit query and to write tables joining query.

Query Details:

Table Name: DB/file_queueFQ/

2. Stream Selector - Use the Steam selector to specify the input stream to be consumed by the activity when there are two sources (DB).

3. Target Layout - The JSON schema for the source data (database) will be designed to be utilized in the RESTful API for the user interface. JSON is selected for its compatibility with RESTful APIs.

4. Mapping - Load the database schema and the target schema (JSON) to do one-to-one mapping.

   1. Apply the for each loop to fetch the data one by one.

5. 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.

Follow the steps below to create a REST Provider:

1. Click Configure > WEB SERVICES > REST Provider.

2. Click Create REST Provider. 

3. In the Create REST Provider window, type the name and description of the new Web Service Provider service in the Name and Description fields respectively.

4. Type API Version, for example, your API version can be 1

5. Type the resource end path URL in the Resource End Path field. The URL can be static or dynamic. Static URL example:  /get/File 

6. Select the process flow name to trigger with the web service from the Process Flow Name field. example: Pf_Attachment

   1. Set parameterName attribute of the context source should be restRequest

      1. fileQueueId-This process will generate a unique File ID for each file.

      2. fileType - Type of file downloading such as Input, Output, and Report files.

7. Click Add Method and select GET as the method type.

8. Select the Response Schema (For example, we are opting for the schema that has been utilized in the process flow as the target schema)

9. 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