Learning Objective

Learn how data is stored in the Solution DB.
Understand the process flow design that supports data processing.
Learn how to write and execute a joining query to fetch necessary information from the database (DB).
Understand how to create a REST provider URL and call the process flow to fetch data.
Identify the attributes required for the UI (web form).
Gain knowledge of the backend server's steps in querying the database, retrieving relevant information, and sending this data to the front end for display.

Overview

In this SIC use case, data is stored in the Solution DB. The data retrieval involves writing a joining query to fetch the necessary information from the backend. The query will be based on the attributes required for the UI, such as File Phase, Error Description, Total Record Count, Unique Record Count, Duplicate Record Count, and File Status.

Use cases

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

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.

This use case describes the implementation of REST services to retrieve data related to Good Records, Error Records, Pass Percentage, File Status, Error Description, Phase V3, and Phase EBMR for the File Queue. The services will also support pagination and provide information for the Solution table.

Step-by-Step Guide to Design Backend Service.

Design Process flow
Use Queary Editor to write a joining query
Create REST Provider End-point
Publish the Provider (REST URL) at UI

Prerequisite:

Download the SIC object
Create Solution DB and Table
Deploy User Interface WAR

1. Download SIC object and deploy

2. Creating Solution DB Table

Database Structure

The tables in the Solution DB should be structured to support these queries efficiently. Here is an example schema:

Run the following query in the specified order to create backend tables.

CREATE TABLE phase (
  ID varchar(10) NOT NULL,
  PHASE_NAME varchar(50) NOT NULL,
  CREATED_BY varchar(50) NOT NULL,
  CREATED_DATE datetime NOT NULL,
  LAST_MODIFIED_BY varchar(50) NOT NULL,
  LAST_MODIFIED_DATE datetime NOT NULL,
  PRIMARY KEY (ID)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

CREATE TABLE `solution_configuration` (
  `ID` int NOT NULL AUTO_INCREMENT,
  `CATEGORY` varchar(50) NOT NULL,
  `PROPERTY_NAME` varchar(50) NOT NULL,
  `PROPERTY_DEFAULT` varchar(50) DEFAULT NULL,
  `PROPERTY_VALUE` varchar(50) DEFAULT NULL,
  `PROPERTY_ORDER` int DEFAULT NULL,
  `ACTIVE_FLAG` varchar(10) NOT NULL,
  `CREATED_BY` varchar(50) NOT NULL,
  `CREATED_DATE` datetime NOT NULL,
  `LAST_MODIFIED_BY` varchar(50) NOT NULL,
  `LAST_MODIFIED_DATE` datetime NOT NULL,
  `TRANSACTION_NAME` varchar(50) DEFAULT NULL,
  PRIMARY KEY (`ID`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;


CREATE TABLE error_code (
  ID int NOT NULL AUTO_INCREMENT,
  ERROR_CODE varchar(10) NOT NULL,
  ERROR_MESSAGE varchar(255) NOT NULL,
  PHASE_ID varchar(10) NOT NULL,
  PRIMARY KEY (ID),
  UNIQUE KEY UC_ERROR_CD (ERROR_CODE),
  KEY PHASE_ID (PHASE_ID),
  CONSTRAINT error_code_ibfk_1 FOREIGN KEY (PHASE_ID) REFERENCES phase (ID)
) ENGINE=InnoDB AUTO_INCREMENT=104 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

Deploy User Interface WAR
1. Download the WAR file - Click here to download it.
2. Steps to deploy GUI WAR solution on Adeptia
  1. Ensure Adeptia Connect is Running:
    - Verify that the Adeptia Connect service is active and running before beginning the deployment process.
  2. Prepare the WAR File:
    - Locate and copy the WAR file created for the GUI.
  3. Access the Connect Portal Directory:
    - Navigate to the directory where the Connect Portal is installed: <Connect_Installed_Location>/ConnectPortal/webapp/wars.
  4. Deploy the WAR File:
    - Paste the copied WAR file into the wars directory.
    - Wait for a few minutes to ensure the file is fully transferred and recognized by the system.
  5. Restart the Connect Portal:
    - Restart the Connect Portal service to apply the new deployment.
  6. Verify Deployment:
    - After the restart, check the Connect Portal to confirm that the new GUI is accessible and functioning as expected.
  Note: It is crucial to ensure that Adeptia Connect remains in running mode throughout the deployment.
3. Steps to Publish a Web Form in Adeptia Connect
  1. Navigate to the Configure Tab:
    - Go to the Configure tab in Adeptia Connect.
  2. Select the Web Forms Page:
    - From the available options, select the "Web Forms" page.
  3. Initiate Web Form Publishing:
    - Click on "Publish Web Form".
  4. Provide the Required Details:
    - Fill in the following details:
      - Name: Enter a name for the web form.
      - Description: Provide a brief description of the web form.
      - URL: Specify the URL for the web form.
      - Type: Select "Web Page" as the type.
      - Navigation Path: Enter "My Solutions" for the navigation path.
      - Link Name: Provide a link name for the web form.

Adeptia Implementation Service Knowledge Base

SIC: Overview of Adeptia Rest Services Creation for GUI