View Attribute: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
(Created page with "A View Attribute can be also referred to as view characteristic or view field. == Creating & Editing View Attributes == To create a new View Attribute, click the "Create" button in the Attributes section of a View details page: IMAGE A View Attribute must have: * A unique and conformant name * An Observable * A Measurement * A path === Name === The attribute's name must consist of letters, numbers, or underscores and start with a letter. === Observable/Measu...")
 
 
(5 intermediate revisions by the same user not shown)
Line 4: Line 4:
To create a new View Attribute, click the "Create" button in the Attributes section of a [[View]] details page:
To create a new View Attribute, click the "Create" button in the Attributes section of a [[View]] details page:


IMAGE
[[File:Phenom-data model-details view attr create.png|1200px|border]]
 
[[File:Phenom-data model-details view attr new.png|1000px|border]]


A View Attribute must have:
A View Attribute must have:
* A unique and conformant name
* A unique and conformant name
* An [[Observable]]
* An [[Observable]]
* A Measurement
* A [[Measurement]]
* A path
* A path


Line 15: Line 17:
The attribute's name must consist of letters, numbers, or underscores and start with a letter.
The attribute's name must consist of letters, numbers, or underscores and start with a letter.


=== Observable/Measurement ==
=== Observable/Measurement ===
The user can either start by selecting an Observable and then the Measurement - the Measurement list will be filtered to the Measurements realizing the selected Observable - or select the Measurement first which will automatically select the Observable the Measurement realizes.
The user can either start by selecting an Observable and then the Measurement - the Measurement list will be filtered to the Measurements realizing the selected Observable - or select the Measurement first which will automatically select the Observable the Measurement realizes.


=== Primitive ===
[[File:Phenom-data model-details view attr obs meas.png|1000px|border]]
Once the Measurement is selected, the user needs to choose the attribute's primitive (this is later used to assert a Platform Type).
 
=== Platform Type ===
Once the Measurement is selected, the user needs to either create a new Platform Type or select an existing one by clicking "Select Platform Type"
 
[[File:Phenom-data model-details view attr new ptf type.png|1000px|border]]


[[]]
[[File:Phenom-data model-details view attr select ptf type.png|1000px|border]]


=== Path ===
=== Path ===
To add a path to the attribute, the user must add a semantic path using the path builder. The path is built hop by hop, starting with the entity/association attribute typing the selected observable.
The final step in creating a View Attribute is to add a semantic path using the path builder. The path is built hop by hop, starting with the entity/association attribute typing the selected observable. Each hop must be committed by clicking the checkmark before being able to move to the next. The last selected hop can be removed by clicking the x next to the new hop box. The current path of the attribute is rendered under the Path section title.
 
[[File:Phenom-data model-details view attr path1.png|1000px|border]]


Each hop must be committed by clicking the checkmark before being able to move to the next. A hop can be removed by clicking the x next to the new hop box.
After committing a hop, if there are additional hops that can be added, they will appear in the dropdown list, otherwise the text "No Possible Options" will appear.


After committing a hop, if there are additional hops you can make, they will appear in the clickable list, otherwise the text "No Possible Options" will appear.
[[File:Phenom-data model-details view attr path2.png|1000px|border]]
Additionally, the path you're creating will render directly below Path.


Saving
[[File:Phenom-data model-details view attr path3.png|1000px|border]]
Once you've set all of the above required fields, click the Save button on the bottom right corner.
If the characteristic saved, you should get a green popup stating it was saved successfully:


Creating a Nesting View Attribute
The circling arrow and the X next to the commit button respectively resets and cleans the path.
A nesting view field can either be a "Foreign Reference" or a "Privately Scoped" attribute.  


The attribute is marked as "privately scoped" when the checkbox is checked.
[[File:Phenom-data model-details view attr path4.png|1000px|border]]
The attribute is marked as "foreign reference" when the checkbox is unchecked.  New nesting view fields will default to foreign reference.


== Creating & Editing Nesting View Attributes ==
To create a new Nesting View Attribute, click the "Add Nesting" button in the Attributes section of a View details page:


Creating a nesting view field:
[[File:Phenom-data model-details nesting view attr create.png|1000px|border]]


The nesting view field must point to a view with a uniform projected characteristic.
A Nesting View Attribute must have:
The foreign referenced nesting view field's uniform projected characteristic must match the type of the last hop of the perspective path used by any field that nests it.
* A unique and conformant name
Fill in the desired fields and click save when finished.
* A View
* A path
* Be Privately Scoped or Foreign Reference


Nesting View Attributes are created and edited inline. Any new or updated Nesting View Attributes will be saved when the user clicks on the "Save" button either for the row or for the entire View.


A Nesting View Attribute must point to a view with a uniform projected characteristic. The foreign referenced Nesting View Attribute's uniform projected characteristic must match the type of the last hop of the perspective path used by any field that nests it.


Creating a nesting view field within a Composite View:
A Nesting View Attribute can either be a "Foreign Reference" or a "Privately Scoped" attribute. If the Private checkbox is checked, then the attribute is marked as "Privately Scoped" otherwise, it is marked as "Foreign Reference". New Nesting View Attribute defaults to "Privately Scoped".


When switching from Nesting to a Composite View.  The Path/Perspective attribute and the Private attribute is cleared on save.
Note that when switching from a Nesting to a Composite View, the Path/Perspective attribute and the Private attribute are cleared on save.

Latest revision as of 09:43, 13 October 2022

A View Attribute can be also referred to as view characteristic or view field.

Creating & Editing View Attributes

To create a new View Attribute, click the "Create" button in the Attributes section of a View details page:

A View Attribute must have:

Name

The attribute's name must consist of letters, numbers, or underscores and start with a letter.

Observable/Measurement

The user can either start by selecting an Observable and then the Measurement - the Measurement list will be filtered to the Measurements realizing the selected Observable - or select the Measurement first which will automatically select the Observable the Measurement realizes.

Platform Type

Once the Measurement is selected, the user needs to either create a new Platform Type or select an existing one by clicking "Select Platform Type"

Path

The final step in creating a View Attribute is to add a semantic path using the path builder. The path is built hop by hop, starting with the entity/association attribute typing the selected observable. Each hop must be committed by clicking the checkmark before being able to move to the next. The last selected hop can be removed by clicking the x next to the new hop box. The current path of the attribute is rendered under the Path section title.

After committing a hop, if there are additional hops that can be added, they will appear in the dropdown list, otherwise the text "No Possible Options" will appear.

The circling arrow and the X next to the commit button respectively resets and cleans the path.

Creating & Editing Nesting View Attributes

To create a new Nesting View Attribute, click the "Add Nesting" button in the Attributes section of a View details page:

A Nesting View Attribute must have:

  • A unique and conformant name
  • A View
  • A path
  • Be Privately Scoped or Foreign Reference

Nesting View Attributes are created and edited inline. Any new or updated Nesting View Attributes will be saved when the user clicks on the "Save" button either for the row or for the entire View.

A Nesting View Attribute must point to a view with a uniform projected characteristic. The foreign referenced Nesting View Attribute's uniform projected characteristic must match the type of the last hop of the perspective path used by any field that nests it.

A Nesting View Attribute can either be a "Foreign Reference" or a "Privately Scoped" attribute. If the Private checkbox is checked, then the attribute is marked as "Privately Scoped" otherwise, it is marked as "Foreign Reference". New Nesting View Attribute defaults to "Privately Scoped".

Note that when switching from a Nesting to a Composite View, the Path/Perspective attribute and the Private attribute are cleared on save.