Frequently Ask Questions

Question 1: What is the main purpose of this use case?

Answer: The main purpose of this use case is to implement REST services that allow users to download various types of files (Input file, Output file, Dropped record file, Error file, Duplicate record file) from the database, enabling users to perform these tasks directly from the front end.

Question 2: Who are the actors involved in this use case?

Answer: The actors involved are:

• User

• Backend Server

• Database (Solution DB)

• UI (Web Form)

Question 3: What are the preconditions for this use case?

Answer: The preconditions are:

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

Question 4: What should happen after the REST services are used?

Answer: After the REST services are used, users should be able to download the specified files directly from the UI, with the requested files retrieved from the database and provided to the user for download.

Question 5: What are the key steps involved in the process flow for downloading files?

Answer: The key steps involved are:

1. User initiates file download request via UI.

2. UI sends HTTP GET request to the REST provider API endpoint.

3. REST provider API calls the default flow to handle the file retrieval process.

4. Backend service retrieves the specified file from the database.

5. Backend service returns the file data to the REST provider API.

6. REST provider API sends the response containing the file data back to the UI.

7. UI processes the response and initiates the file download for the user.

Question 6: What types of files can be downloaded using this REST service?

Answer: The types of files that can be downloaded include:

• Input file

• Output file

• Dropped record file

• Error file

• Duplicate record file

Question 7: What action does the user perform to initiate a file download?

Answer: The user interacts with the User Interface (UI) by clicking the download button or selecting the download option to initiate a file download.

Question 8: How does the UI send the request to the REST provider API?

Answer: The UI sends the request to the REST provider API using an HTTP GET method.

Question 9: What is the role of the backend service in this process flow?

Answer: The role of the backend service is to retrieve the specified file attachment from the server or database and send the file data back to the REST provider API.

Question 10: What format is used for the data in the process flow?

Answer: The data in the process flow is formatted in JSON.

Question 11: What must be done once the process flow has been designed?

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

Question 12: What is the purpose of creating DbInfo and DbLayout in the source activity?

Answer: The purpose of creating DbInfo and DbLayout in the source activity is to efficiently retrieve attributes from multiple tables and display relevant information on the user interface, implementing where clause conditions to filter the data as needed.

Question 13: What is the significance of the ContextTarget in the process flow?

Answer: The ContextTarget is used to store data in the flow, which will be carried by the REST provider.

Question 14: What is the function of the REST provider in this use case?

Answer: The function of the REST provider is to handle the HTTP requests, invoke the corresponding process flow, retrieve the required file from the database, and send the response back to the UI for download.

Question 15: What must be done to create a REST provider endpoint?

Answer: To create a REST provider endpoint, you need to:

1. Click Configure > WEB SERVICES > REST Provider.

2. Click Create REST Provider.

3. Enter the name and description of the new Web Service Provider.

4. Specify the API version and resource end path URL.

5. Select the process flow name to trigger with the web service.

6. Bind necessary variables in the user interface to process requests.

7. Add the GET method and select the response schema.

8. Save the configuration.

Question 16: How is the REST provider URL linked with the user interface (UI)?

Answer: The REST provider URL is linked with the user interface (UI) by publishing the provider and integrating the REST URL with the UI to present the data on the UI.