Versions Compared

Version Old Version 19 New Version Current
Changes made by

Deepak Kumar (Deactivated)

Deepak Kumar (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
panelIconId1f914
panelIcon:thinking:
panelIconText🤔
bgColor#E6FCFF

This use case outlines the implementation of REST services to retrieve detailed data about file processing statues statutes and error handling within a system. The services are designed to provide specific metrics and information crucial for monitoring and managing file queues efficiently.

...

This flow contains the following functionality:

  • First flow – It enables the advanced search option like

  • Default flow - It shows the last 30 days' records like errors, status, warnings, and good records

  • Last flow – It enables a search option with an emp name or SSN

...

  1. User Interface (UI) Request:

    • A user interacts with the UI and triggers a request to view application data.

    • The UI sends a request to the backend service via the REST API.

  2. API Endpoint Invocation:

    • The REST provider API receives the request and routes it to the appropriate endpoint.

    • The endpoint is configured to handle specific data queries and statuses (good records, error records, warnings, etc.).

  3. Backend Service Initialization:

    • The API endpoint invokes the backend service responsible for processing the request.

    • The backend service starts by validating the incoming request parameters.

  4. Data Retrieval:

    • The backend service queries the database or data storage to fetch the requested application data.

    • It retrieves data based on the requested criteria (e.g., all records, good records, error records, warnings).

  5. Data Processing:

    • The backend service processes the retrieved data to format it according to the requirements.

    • It filters and categorizes the data into different statuses (good records, error records, warnings).

  6. Response Preparation:

    • The processed data is then packaged into a structured response.

    • The response includes all the necessary details and statuses requested by the user.

  7. Sending the Response:

    • The backend service sends the prepared response back to the REST provider API.

    • The API then forwards the response to the UI.

  8. UI Displays Data:

    • The UI receives the response and parses the data.

    • It displays the data to the user, showing complete statuses like good records, error records, warnings, etc.

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.

...

  1. Context Target Using ContextTarget to store data in the flow which will be carried by the REST provider.

...

Info

Only utilize the restResponse variable and ContentTarget parameter name to handle the data for output.

b. Advanced Search Flow - To Search Start Date and End Date

...

  1. Input Parameters:

    • The user is presented with input fields for Start Date and End Date.

    • The user enters the desired Start Date and End Date to define the search parameters.

  2. Input Validation:

    • The system validates the input dates to ensure they are in the correct format and logical order (e.g., Start Date is not after End Date).

    • If the validation fails, the system prompts the user to correct the input.

  3. Search Trigger:

    • Once the input dates are validated, the user initiates the search by clicking a 'Search' button.

  4. Front-End Processing:

    • The front end captures the input parameters and prepares an API request to the back-end system.

    • The API request includes the Start Date and End Date as query parameters.

  5. Back-End Request Handling:

    • The back-end system receives the API request.

    • It processes the request by querying the database for records that fall within the specified date range.

  6. Data Filtering:

    • The back-end system applies the date filters to the application data.

    • The system retrieves the relevant records that match the search criteria.

  7. Response Construction:

    • The back-end system constructs a response containing the filtered data.

    • The response is sent back to the front-end system.

  8. Data Display:

    • The front-end system receives the response from the back-end.

    • It processes the response and displays the filtered results to the user in a user-friendly format.

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

...

Info

You must utilize the EDIT Query option to efficiently retrieve attributes from multiple tables and display relevant information on the user interface. Additionally, you implement conditions to filter the data as needed.

image-20240625-141152.pngImage Removed

Query Details:

Table Name: DB/application_dataORDERBYFILE_QUEUE_IDDESCLIMIT25OFFSETstart/

...

titleSQL Query

...

  1. Gateway Condition: This condition enables the retrieval of a value by utilizing user-defined search criteria within the UI's advanced search feature. The code streamlines the process flow in alignment with the designated start_date.

...

Code Description:

Code

Description

String Query = context.get("start_date") == null ? "" : context.get("start_date");

if(Query!=null&&Query.length()>0)
{
return true;

}
else{
return false;
}

The code checks whether the start_date retrieved from the context is valid, meaning it is not null and not an empty string. If the start_date is valid, it returns true; otherwise, it returns false. This can be used to validate the presence of a start_date value before performing further actions.

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

...

Info

You must utilize the EDIT Query option to efficiently retrieve attributes from multiple tables and display relevant information on the user interface. Additionally, you implement conditions to filter the data as needed.

image-20240625-141152.pngImage Added

Query Details:

Table Name: DB/application_dataORDERBYFILE_QUEUE_IDDESCLIMIT25OFFSETstart/

Expand
titleSQL Query

SELECT ID,FILE_QUEUE_ID,APPLICATION_TYPE,RECORD_STATUS,ERROR_MESSAGE,WARNING_MESSAGE,SSN,EMPLOYEE_ID,EMPLOYEE_FIRST_NAME,EMPLOYEE_LAST_NAME,COVERAGE_ID,PRODUCT_TYPE_CODE,GROUP_POLICY_NUMBER,BENEFIT_PLAN_IDENTIFIER,CREATED_BY,CREATED_DATE,LAST_MODIFIED_BY,LAST_MODIFIED_DATE,BENEFIT_CLASS_IDENTIFIER,MASTER_AGREEMENT_NUMBER,EMPLOYEE_MIDDLE_NAME,EMPLOYEE_SUFFIX_CODE,EMPLOYEE_BIRTH_DATE,EMPLOYEE_GENDER_CODE,EMPLOYEE_MARITAL_STATUS_CODE,EMPLOYEE_HOME_PHONE,EMPLOYEE_EMAIL,EMPLOYEE_ALTERNATE_EMAIL,EMPLOYEE_MAILING_ADDRESS_FIRST_LINE_ADDRESS,EMPLOYEE_MAILING_ADDRESS_THIRD_LINE_ADDRESS,EMPLOYEE_MAILING_ADDRESS_CITY_NAME,EMPLOYEE_MAILING_ADDRESS_STATE_PROVINCE_CODE,EMPLOYEE_MAILING_ADDRESS_POSTAL_CODE,EMPLOYEE_MAILING_ADDRESS_COUNTRY_CODE,EMPLOYEE_IDENTIFIER,EMPLOYEE_TOBACCO_USECODE,EMPLOYEE_WORK_ADDRESS_STATE_PROVINCE_CODE,EMPLOYMENT_INFORMATION_EMPLOYMENT_STATUS_CODE,EMPLOYMENT_INFORMATION_EMPLOYMENT_TYPE_CODE,EMPLOYMENT_INFORMATION_ORIGINAL_HIRE_DATE,EMPLOYMENT_INFORMATION_MOST_RECENT_HIRE_DATE,EMPLOYMENT_INFORMATION_ADJUSTED_SERVICE_DATE,EMPLOYMENT_INFORMATION_TERMINATION_DATE,EMPLOYMENT_INFORMATION_JOB_TITLE_TEXT,EMPLOYMENT_INFORMATION_OCCUPATION_TEXT,EMPLOYMENT_INFORMATION_PAYROLL_FREQUENCY_QUANTITY,EMPLOYMENT_INFORMATION_EXEMPT_CODE,EMPLOYMENT_INFORMATION_UNION_INDICATOR,EMPLOYMENT_INFORMATION_WORK_LOCATION_TEXT,EMPLOYMENT_INFORMATION_WORK_STATE_CODE,COVERAGE_BENEFIT_SUBCLASS_IDENTIFIER,COVERAGE_COVERAGERIDER_RIDEROPTION_IDENTIFIER,COVERAGE_BILL_GROUP_IDENTIFIER,COVERAGE_BILL_SUB_GROUP_IDENTIFIER,COVERAGE_TIER_CODE,COVERAGE_EFFECTIVE_DATE,COVERAGE_TERMINATION_DATE,COVERAGE_BENEFIT_AMOUNT,DEPENDENT_TOBACCO_USECODE,DEPENDENT_FIRST_NAME,DEPENDENT_LAST_NAME,DEPENDENT_BIRTH_DATE,DEPENDENT_GENDER_CODE,DEPENDENT_RELATIONSHIP_TYPE_CODE,DEPENDENT_BENEFIT_AMOUNT,EVENT_DATE,EVENT_TYPE_REASON_CODE,EVENT_TYPE_CODE,EMPLOYEE_POSITION,POLICY_PRODUCTID_CLASS_POSITION FROM application_data

Expand
titleWhere Clause

WHERE CREATED_DATE BETWEEN '$$start_date$$' AND DATE_ADD('$$end_date$$', INTERVAL 1 DAY) AND FILE_QUEUE_ID =$$fileQueueId$$ ORDER BY FILE_QUEUE_ID DESC

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

...

  1. Mapping - You must load the database schema and the target schema (JSON) to finalize the mapping process.

...

  1. Context Target -The target will be ContextTarget to store data in the flow for the REST provider.

...

c. Process flow - To search By File Attribute.

...

,EVENT_DATE,EVENT_TYPE_REASON_CODE,EVENT_TYPE_CODE,EMPLOYEE_POSITION,POLICY_PRODUCTID_CLASS_POSITION FROM application_data

Expand
titleWhere Clause

WHERE CREATED_DATE BETWEEN '$$start_date$$' AND DATE_ADD('$$end_date$$', INTERVAL 1 DAY) AND FILE_QUEUE_ID =$$fileQueueId$$ ORDER BY FILE_QUEUE_ID DESC

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

...

  1. Mapping - You must load the database schema and the target schema (JSON) to finalize the mapping process.

...

  1. Context Target -The target will be ContextTarget to store data in the flow for the REST provider.

...

Info

Only utilize the restResponse variable and ContentTarget parameter name to handle the data for output.

c. Process flow - To search By File Attribute.

This flow process enables search options by file attribute like FILE_QUEUE_ID, SSN, EMPLOYEE_LAST_NAME, GROUP_POLICY_NUMBER, COVERAGE_ID, EMPLOYEE_FIRST_NAME, EMPLOYEE_ID & RECORD_STATUS. 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.

...

  1. User Initiates Search:

  • User Interface: The user accesses a search interface on the front end. This interface provides input fields for each of the file attributes mentioned.

  • Input: The user enters search criteria in one or more fields (e.g., SSN, EMPLOYEE_LAST_NAME,

...

  1. User Initiates Search:

  • User Interface: The user accesses a search interface on the front end. This interface provides input fields for each of the file attributes mentioned.

  • Input: The user enters search criteria in one or more fields (e.g., SSN, EMPLOYEE_LAST_NAME, etc.).

  1. Front End Validation:

  • Form Validation: The front end performs basic validation to ensure the inputs are in the correct format (e.g., SSN is numeric and of the correct length, EMPLOYEE_LAST_NAME is alphabetic, etc.).

    • Feedback: If any inputs are invalid, the user is prompted to correct them before proceeding.

  1. Search Request Submission:

  • Request Construction: The front end constructs a search request based on the input fields filled by the user. This request typically includes a payload with the search criteria.

    • API Call: The front end sends the search request to the back end via an API call.

  1. Backend Processing:

  • Request Reception: The back end receives the search request.

    • Validation and Sanitization: The back end further validates and sanitizes the input to ensure security and integrity.

    • Database Query: The back end constructs and executes a query against the database based on the search criteria

  1. Data Retrieval and Filtering:

  • Query Execution: The database executes the query and returns the results to the back end.

    • Filtering: The back end may apply additional filtering or business logic to the results if necessary.

  1. Front End Display:

  • Response Reception: The front end receives the response.

    • Result Rendering: The front end processes the response data and displays the filtered results to the user in a user-friendly format (e.g., a table or list).

    • Feedback: If no results are found, the front end provides appropriate feedback to the user (e.g., "No records found matching the search criteria").

...

  • etc.).

  1. Front End Validation:

  • Form Validation: The front end performs basic validation to ensure the inputs are in the correct format (e.g., SSN is numeric and of the correct length, EMPLOYEE_LAST_NAME is alphabetic, etc.).

    • Feedback: If any inputs are invalid, the user is prompted to correct them before proceeding.

  1. Search Request Submission:

  • Request Construction: The front end constructs a search request based on the input fields filled by the user. This request typically includes a payload with the search criteria.

    • API Call: The front end sends the search request to the back end via an API call.

  1. Backend Processing:

  • Request Reception: The back end receives the search request.

    • Validation and Sanitization: The back end further validates and sanitizes the input to ensure security and integrity.

    • Database Query: The back end constructs and executes a query against the database based on the search criteria

  1. Data Retrieval and Filtering:

  • Query Execution: The database executes the query and returns the results to the back end.

    • Filtering: The back end may apply additional filtering or business logic to the results if necessary.

  1. Front End Display:

  • Response Reception: The front end receives the response.

    • Result Rendering: The front end processes the response data and displays the filtered results to the user in a user-friendly format (e.g., a table or list).

    • Feedback: If no results are found, the front end provides appropriate feedback to the user (e.g., "No records found matching the search criteria").

Process flow activity:

  1. Gateway Activity: This condition retrieves a value based on the search criteria provided by the user interface, using the advanced search option. The code facilitates the flow to retrieve data according to the specified search query.

...

Code Description:

Gateway Code

Description

String Query = context.get("searchQuery") == null ? "" : context.get("searchQuery");

if(Query!=null&&Query.length()>0)
{
return true;

}
else{
return false;
}

The code is designed to determine whether the searchQuery retrieved from the context is valid, meaning it is not null and not an empty string. If searchQuery is valid, it returns true; otherwise, it returns false. This could be used to validate that a search query has been provided before proceeding with further operations.

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

...

Info

You must utilize the EDIT Query option to efficiently retrieve attributes from multiple tables and display relevant information on the user interface. Additionally, you implement conditions to filter the data as needed.

...

Expand
titleSQL Query

SELECT ID,FILE_QUEUE_ID,APPLICATION_TYPE,RECORD_STATUS,ERROR_MESSAGE,WARNING_MESSAGE,SSN,EMPLOYEE_ID,EMPLOYEE_FIRST_NAME,EMPLOYEE_LAST_NAME,COVERAGE_ID,PRODUCT_TYPE_CODE,GROUP_POLICY_NUMBER,BENEFIT_PLAN_IDENTIFIER,CREATED_BY,CREATED_DATE,LAST_MODIFIED_BY,LAST_MODIFIED_DATE,BENEFIT_CLASS_IDENTIFIER,MASTER_AGREEMENT_NUMBER,EMPLOYEE_MIDDLE_NAME,EMPLOYEE_SUFFIX_CODE,EMPLOYEE_BIRTH_DATE,EMPLOYEE_GENDER_CODE,EMPLOYEE_MARITAL_STATUS_CODE,EMPLOYEE_HOME_PHONE,EMPLOYEE_EMAIL,EMPLOYEE_ALTERNATE_EMAIL,EMPLOYEE_MAILING_ADDRESS_FIRST_LINE_ADDRESS,EMPLOYEE_MAILING_ADDRESS_THIRD_LINE_ADDRESS,EMPLOYEE_MAILING_ADDRESS_CITY_NAME,EMPLOYEE_MAILING_ADDRESS_STATE_PROVINCE_CODE,EMPLOYEE_MAILING_ADDRESS_POSTAL_CODE,EMPLOYEE_MAILING_ADDRESS_COUNTRY_CODE,EMPLOYEE_IDENTIFIER,EMPLOYEE_TOBACCO_USECODE,EMPLOYEE_WORK_ADDRESS_STATE_PROVINCE_CODE,EMPLOYMENT_INFORMATION_EMPLOYMENT_STATUS_CODE,EMPLOYMENT_INFORMATION_EMPLOYMENT_TYPE_CODE,EMPLOYMENT_INFORMATION_ORIGINAL_HIRE_DATE,EMPLOYMENT_INFORMATION_MOST_RECENT_HIRE_DATE,EMPLOYMENT_INFORMATION_ADJUSTED_SERVICE_DATE,EMPLOYMENT_INFORMATION_TERMINATION_DATE,EMPLOYMENT_INFORMATION_JOB_TITLE_TEXT,EMPLOYMENT_INFORMATION_OCCUPATION_TEXT,EMPLOYMENT_INFORMATION_PAYROLL_FREQUENCY_QUANTITY,EMPLOYMENT_INFORMATION_EXEMPT_CODE,EMPLOYMENT_INFORMATION_UNION_INDICATOR,EMPLOYMENT_INFORMATION_WORK_LOCATION_TEXT,EMPLOYMENT_INFORMATION_WORK_STATE_CODE,COVERAGE_BENEFIT_SUBCLASS_IDENTIFIER,COVERAGE_COVERAGERIDER_RIDEROPTION_IDENTIFIER,COVERAGE_BILL_GROUP_IDENTIFIER,COVERAGE_BILL_SUB_GROUP_IDENTIFIER,COVERAGE_TIER_CODE,COVERAGE_EFFECTIVE_DATE,COVERAGE_TERMINATION_DATE,COVERAGE_BENEFIT_AMOUNT,DEPENDENT_TOBACCO_USECODE,DEPENDENT_FIRST_NAME,DEPENDENT_LAST_NAME,DEPENDENT_BIRTH_DATE,DEPENDENT_GENDER_CODE,DEPENDENT_RELATIONSHIP_TYPE_CODE,DEPENDENT_BENEFIT_AMOUNT,EVENT_DATE,EVENT_TYPE_REASON_CODE,EVENT_TYPE_CODE,EMPLOYEE_POSITION,POLICY_PRODUCTID_CLASS_POSITION FROM application_data

Expand
titleWhere Clause

WHERE ( FILE_QUEUE_ID =$$fileQueueId$$) AND (APPLICATION_TYPE like '%$$searchQuery$$%' OR RECORD_STATUS like

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

...

  1. Mapping - You must load the database schema and the target schema (JSON) to finalize the mapping process.

image-20240625-141013.png

  1. Context Target Using ContextTarget to store data in the flow which will be carried by the REST provider.

...

Info

Only utilize the restResponse variable and ContentTarget parameter name to handle the data for output.

2. Create REST Provider End-point

...