Page Comparison

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

...

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

...

Step 1

...

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

...

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.

...

Field Name	Description	Data Type	Is Required?	Validation
Entity Attribute Model Name	The name of the attribute	String	Yes	No spaces
Entity Attribute Model data format	The format of the attribute - character, numeric, or integer	String	Yes	one of the three in column B
Entity Attribute Model Data Length	The length of the field	Numeric	Yes	only positive numbers
Entity Attribute Model Data Precision	if numeric then precision	Numeric	Yes	only positive numbers
Entity Attribute Unique Ind	Yes/No Indicator	(Yes or No flag)	Yes	YES/NO
Entity Attribute In Use Ind	Yes/No Indicator	(Yes or No flag)	Yes	YES/NO
Entity Attribute Description	The metadata definition of the attribute	String	Yes
Entity Attribute Sample Value	The sample value of the attribute	String	Yes	Length of field should be same as input of “Entity Attribute Model Data Length”
Entity Attribute Default Value	The default value to assign if not imputing to treat nulls	String	Yes	Length of field should be same as input of “Entity Attribute Model Data Length”

Define Transform, Quality and Validation rules

...

...

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

Field Name	Description	Data Type	Is Required?	Validation
Entity Attribute Transform Rule Inbound	The transform rule for the attribute	String	Yes
Entity Attribute Transform Rule Outbound	The transform rule for the attribute	String	Yes	by default
Entity Attribute Validation Rule	the validation rule for the attribute	String	Yes	by default NONE
Entity Attribute Validation Rule Description	the validation rule for the attribute	String	Yes	by default NONE
Entity Attribute Validation Rule Iterate by Key Role	Yes/No Indicator	String	Yes	YES/NO
Entity Attribute Quality Rule	a~b	String	Yes	Has to have “~” in the rule or “NONE” if there is no quality rule
Entity Attribute Quality Rule Description	a~b	String	Yes
Entity Attribute Quality Rule Iterate By Key Role	other than a or b	String	Yes

Define Relationships

...

...

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

Field Name	Description	Data Type	Is Required?	Validation
Entity Attribute Impute Method	if the attribute is null, pick out an impute method. For character columns, it's the default value. For numeric nd integers, mean or median	String	Yes	one of the three in column B
Entity Attribute Compare Key Role	Yes/No Indicator	String	Yes	YES/NO
Entity Attribute Filter Key	the construct to filter records	String	Yes	default is NO
Entity Attribute Nested Key Role	Whether the given attribute should be nested used in nesting operatio or not	String	Yes	default is YES
Entity Attribute Parent Lookup Key Role	(Yes or No flag)	String	Yes	YES/NO
Entity Attribute Parent Lookup Location	The hdfs location of the parent entity for performing lookups	String	Yes	default is NONE
Entity Attribute Calendar join key Role	(Yes or No flag)	String	Yes	YES/NO

Define Auditing Preferences

...

...

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

Field Name	Description	Data Type	Is Required?	Validation
Entity Attribute Iqm Codes Match	(Yes or No flag)	String	Yes	YES/NO
Entity Attribute Iqm Metric Match	(Yes or No flag)	String	Yes	YES/NO
Entity Attribute Iqm Iterate By Key Role	(Yes or No flag)	String	Yes	YES/NO
Entity Attribute Eda Dimension	(Yes or No flag)	String	Yes	YES/NO
Entity Attribute Eda Metric	(Yes or No flag)	String	Yes	YES/NO
Entity Attribute Eda Iterate By Key Role	(Yes or No flag)	String	Yes	YES/NO

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.

...

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.

Copyright ©

...

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