Sprngy Platform Meta Model UI Documentation

Disclaimer

Sprngy Platform Documentation Guide

Release 2.0.0

Copyright © Sprngy Corporation. 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:

• SPRNGY Administrators

• SPRNGY Developers

• SPRNGY Architects

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

Pre Requisites

Application is created in Admin UI using the Application Configuration screens and entities and relationships are defined.

Define Meta Model

A meta model is a format that allows to capture detailed information about attributes/columns of data sets that are to be processed. Below are the steps 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

On the Home screen of the admin UI, click ‘Meta Data Configuration' option on side menu and then click 'Meta Model’.

Open

Step 1

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

Open

To create a new Meta Model, select the required Module name and Entity name from the drop down and click 'Submit'.

Alternatively, using the Upload box, meta model (in csv) format can be uploaded for the selected entity.

On clicking ‘Submit’, Admin UI 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.

There are multiple functionalities that are available on this screen:

Add New Attribute

It is provides similar option as before to add attribute name and data type.

Edit Attribute

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

Here are the fields that can be configured on this screen:

Define Transform, Quality and Validation rules

Here are the fields that can be configured on this screen:

Define Relationships

Here are the fields that can be configured on this screen:

Define Auditing Preferences

Here are the fields that can be configured on this screen:

Define Attribute Presentation on Query and Report Layer

Here are the fields that can be configured on this screen:

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.

View Attribute

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

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.

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.

Select the module and entity you want to edit from the drop down and click Submit.

This will load the information you previously stored for that module and entity. First of all there is the entity owner information that you can update. After that there will a list of all the attributes.

You can Edit, View, Delete and Add attributes similar to the Create Meta Model flow as discussed above.

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

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