...
This document is intended for:
BAPCORE SPRINGYCORE Administrators
BAPCORE SPRINGYCORE Developers
BAPCORE SPRINGYCORE Architects
This document is a walkthrough to create , edit, delete and view import model through Big Analytixs UIand edit an import Model through the Sprngy UI.
Pre-requisites:
The list of tools required to run/develop in the UI are as follows:
Visual Studio Code (Developers only)
Python 3.8.10
Flask 1.1.4
Node 14.17.6
npm 7.24.1
R 3.6.3
Big Analytixs Sprngy Libraries
Import Model
An Import import model is used to push data from a relational database to HDFS.
There are three aspects to this model:
Create/Edit Import Model - This flow is to create (in the case it does not exist) or edit (in the case that it exists) an Import Model manually.
Bulk Upload Import Model - Big Analytixs gives you the capability to upload a whole model created in a CSV file without manually creating it Sprngy Platform Bulk Uploads UI Documentation
Run Import Workload - After creating an Import Model, we can run the import workload in order to have data processed for that respective Algorithm
Creating an Import Model:
...
import dataset from source location to sprngy datalake.
Creating an Import Model:
The image below is the Home screen of the UI.
Click on the three lines (pulls up the menu) and click on the “Create Import Model”
...
Screen0:
Clicking on the option above will route you to Screen zero, which is a page where you can select the Module Name and Entity Name that you want to create the Import model for.
...
For example, we are choosing ‘BAPRAM’ as the module name and ‘Customer’ as the entity name.
Form 1:
Clicking on “Create Import Model” will navigate you to the Form1(step 1) page. Form1 requires you to fill out the preEntity details and is a page with two steps. The following is the “Step 1”:
...
From the side menu open ‘Meta Data Configuration' option, then select 'Import Model’ option.
...
Create/Edit Import:
Step 1 -
After clicking on the Import Model menu option below screen will be displayed.
...
To create a new Import Model, select the required Module name and Entity name from the drop down and click 'Submit'.
This checks the existence of a import model. If there is a previously created or even initiated import model then it will bring back that data, if creating import model for the very first time then provides blank fields for input.
Step 2 -
After submission, the below screen will be rendered. Here you can provide information regarding the import model for given entity.
...
This two step form takes information such as entity description and business owner, data owner and IT owner information working on this entity. Once done click on Submit.
Field Name | Description | Data Type | is Required? | Validation
|
|---|---|---|---|---|
Module Name | Choose from the list of modules | String | Yes | One of the seven on the website |
Entity Name | Choose from the list of entities | String | Yes | Only appears after the module name is selected |
Entity Description | The description of the respective entity | String | Yes |
|
Once you click on “Next”, you will be sent to “Step 2” to fill out the other preEntity details. The following image is “Step 2”:
...
Field Name | Description | Data Type | is Required? | Validation |
|---|---|---|---|---|
Entity Business Owner Name | First name + Last name of Entity Business Owner | String | Yes |
|
Entity Business Owner Email | The Business Owner email Id | String | Yes | should have @ |
Entity Data Owner Name | The Data Owner Name of Entity | String | Yes |
|
Entity Data Owner Email | The Data Owner Email of Entity | String | Yes | should have @ |
Entity It Owner Name | The IT owner name of an entity | String | Yes |
|
Entity It Owner Email | The IT owner email of the entity | String | Yes | should have @ |
Vendor Support Name | The vendor support name of the entity.Default Non-editable to support@biganalytixs.com | String | Auto-Fill |
|
Vendor Support Email | The vendor support name of the entity.Default Non-editable to support@biganalytixs.com | String | Auto-Fill |
|
...
After these details have been filled out, you can hit on “Back” to go to “Step 1” or if you are done filling out your PreEntity Details you can hit on “Submit”.
...
Step 3 -
If you hit “Submit”, you will be taken to the form2 form page to fill out all of the Query Details.
...
After you are done with creating all your queries, click on “Final Submit”. This will create your import model in your local HDFS and route you back to your home screen.
Editing Import Model
Home Screen:
Click on the three lines (pulls up the menu) and click on the “Edit Import Model”
...
Edit Import Selection Screen:
In the screenshot below, you will be required to fill out the Module and Entity Name.
...
Clicking on the Submit button will fetch the import model from HDFS and navigate to Form1.
Form1:
If an import model exists, you will be navigated to Form1 with the import model preEntity details pre-populated and editable as shown below:
...
Query Grid Screen:
Clicking on the “Submit” button on the Form1 page, will save your preEntity details locally and route you to the Query/Grid Screen. In this screen, you have the list of SQL queries that exist in the import model.
...
There are multiple functionalities that are available on this screen:
Add New Query - It navigates you to the Form2 page (just as adding another query in the create flow), and you can create another query.
The View Icon - This icon navigates you to another screen that displays the details of the particular query
The Edit Query - This icon navigates to the add query page with pre-filled values. You can change the required field and save the updated query.
Delete Icon - The Delete Icon gives you the ability to delete that particular query.
After making all changes to the import model, you can click on the “Final Submit” button in order to update the existing import model in the HDFS. It is IMPORTANT to remember that you have to click on the “FINAL SUBMIT” button in order for your changes to be permanently saved.
...
Bulk Upload Import Model
There is also one other way to create a import model, that is by uploading a CSV file. For this, you are required to have a import model .csv file with all the required fields. To directly upload a csv -
Home Screen:
The image below is the Home screen of the UI.
From the side menu open ‘Meta Data Configuration' option, then select 'Import Model’ option.
...
Step 1 -
After clicking on the Import Model menu option below screen will be displayed.
...
Select the module and entity for which you want to upload a import model. In the file upload option browse or drag and drop the import model csv file and click Submit.