Versions Compared

Key

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

Disclaimer

Big Analytixs Sprngy Platform Azure Engineering Guide

Release 1.0.0.1

Copyright © Big AnalytixsSprngy. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

This document is intended for:

  • BAPCORE SPRNGYCORE Administrators

  • BAPCORE SPRNGYCORE Developers

  • BAPCORE SPRNGYCORE Architects

This document is a walkthrough to create and edit a Meta Model through the Big Analytixs Sprngy UI.

Pre-requisites:

The list of tools required to run/develop in the UI are as follows:

  1. Visual Studio Code (Developers only)

  2. Python 3.8.10

  3. Flask 1.1.4

  4. Node 14.17.6

  5. npm 7.24.1

  6. R 3.6.3

  7. Big Analytixs Libraries

Meta Model:

A meta model is a format that allows to captured detailed information about attributes of data sets that are to be processed. Below are the processes to Create/Edit a Meta Model from the UI.

Before Creating a meta model, it is important to remember the following:

  1. The unique field while creating an attribute is “entity_attribute_model_name”. You will get an error if you try to create an attribute with the same name.

  2. When the meta model is created, a field called “as_of_date” will be system generated and defaulted. You will not be able to edit or delete that field.

Home Screen:

The image below is the Home screen of the UI.

Click on the three lines (pulls up the menu) and click on the “Create/Edit Meta Model”

...

Screen 0:

...

This checks the existence of a metamodel. There are a few checks taking place:

...

The next page rendered will be of a grid with created column names. To customise or change any configurations click on edit icon of that column name.

Attributes Grid Screen:

Clicking on the “Submit” button on the Form1 page, will save your preEntity details locally and route you to the Attributes/Grid Screen. In this screen you have the list of attributes that exist in the meta model.

...

After making all changes to the meta model, you can click on the “Final Submit” button in order to update the existing meta 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.

Edit Meta Model

Editing a Meta model has similar steps to creating a Meta Model.

Home Screen:

The image below is the Home screen of the UI.

Click on the three lines (pulls up the menu) and click on the “Create/Edit Meta Model”

...

Screen 0:

...

This checks the existence of a metamodel. There are a few checks taking place:

...

On Submit, you will be routed to the MainForm.

Form1(MainForm):

The Mainform requires you to fill out the preEntity details and is a page with two steps. The following is the “Step 1”:

...

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

Attributes Grid Screen:

Clicking on the “Submit” button on the Form1 page, will save your preEntity details locally and route you to the Attributes/Grid Screen. In this screen you have the list of attributes that exist in the meta model.

...

There are multiple functionalities that are available on this screen:

  1. Add New Attribute

- It navigates you to the Form2 as explained below:

...

After you are done filling out the details for a single attribute, click the “SAVE ATTRIBUTE” button to save the file locally and route you back to the Attributes Grid Page.

  1. The View Icon

- This icon navigates you to another screen which displays the details of the particular attribute.

...

  1. Edit Icon -

The Edit icon gives you the ability to edit that particular attribute and save it at every step of the way.

  1. Delete Icon -

The Delete Icon gives you the ability to delete that particular attribute. A pop up will appear reconfirming your decision to delete the attribute.

...