Versions Compared

Key

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

Disclaimer

Sprngy Platform Documentation Guide

...

This document is a walkthrough to create and edit a Meta Model through the 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

Meta Model:

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

...

  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.

From the side menu open ‘Meta Data Configuration' option, then select 'Meta Model’ option.

...

Step 1 -

After clicking on the Meta Model menu option below screen will be displayed.

...

This checks the existence of a metamodel. If there is a previously created or even initiated meta model then it will bring back that data, if creating meta 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 meta 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.

Step 3 -

On the next screen there will be fields to add attribute name (i.e. Column Name) and it’s datatype. This screen is visible only when creating the meta model for first time Add all the column names with it’s datatypes (string,numeric or integer) and click Submit. On submit a meta model will be created with default values for the given values. It will by default add a column ‘as_of_date'. You can also skip this page which would only add the 'as_of_date' column.

...

Step 4 -

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

...

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.

From the side menu open ‘Meta Data Configuration' option, then select 'Meta Model’ option.

...

Step 1 -

After clicking on the Meta Model menu option below screen will be displayed.

...

Once satisfied with the Meta Model changes click on 'Final Submit' to save these changes.

Bulk Upload Meta Model

There is also one other way to create a meta model, that is by uploading a CSV file. For this, you are required to have a meta 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 'Meta Model’ option.

...

Step 1 -

After clicking on the Meta Model menu option below screen will be displayed.

...

Select the module and entity for which you want to upload a meta model. In the file upload option browse or drag and drop the meta model csv file and click Submit.

Copyright © Sprngy. All rights reserved. Not to be reproduced or distributed without express written consent.