Merge pull request #793 from hashmapinc/Tempus-13-DataModel-Docs

TempusElaboration-13documentation for managing a data model
hashmapinc · Jan 24, 2019 · 6532d86 · 6532d86
2 parents cc498f9 + c61aac1
commit 6532d86
Show file tree

Hide file tree

Showing 14 changed files with 86 additions and 10 deletions.
diff --git a/docs/_images/datamodel/datamodel-assign.png b/docs/_images/datamodel/datamodel-assign.png
diff --git a/docs/_images/datamodel/datamodel-canvas.png b/docs/_images/datamodel/datamodel-canvas.png
diff --git a/docs/_images/datamodel/datamodel-create.png b/docs/_images/datamodel/datamodel-create.png
diff --git a/docs/_images/datamodel/datamodel-page.png b/docs/_images/datamodel/datamodel-page.png
diff --git a/docs/_images/datamodel/datamodel-result.png b/docs/_images/datamodel/datamodel-result.png
diff --git a/docs/_images/datamodel/object-attributes.png b/docs/_images/datamodel/object-attributes.png
diff --git a/docs/_images/datamodel/object-info.png b/docs/_images/datamodel/object-info.png
diff --git a/docs/_images/datamodel/object-relationships.png b/docs/_images/datamodel/object-relationships.png
diff --git a/docs/_images/datamodel/object-results.png b/docs/_images/datamodel/object-results.png
diff --git a/docs/_images/datamodel/object-review.png b/docs/_images/datamodel/object-review.png
diff --git a/docs/_images/datamodel/object-saved.png b/docs/_images/datamodel/object-saved.png
diff --git a/docs/datamodel/datamodel.rst b/docs/datamodel/datamodel.rst
@@ -0,0 +1,61 @@
+####################
+Data Model Reference
+####################
+
+This reference document explains different actions and operation related to Data Model.
+The document includes creation, updation, deletion and assignment of Data Model to different Business Units and creating Asset Landing Pages for DataModel Objects.
+
+
+Data Model Information
+======================
+
+.. image:: ../_images/datamodel/datamodel-page.png
+    :align: center
+
+The page displays the overall created Data Model for login tenant admin.
+
+Data Model Creation
+===================
+
+.. image:: ../_images/datamodel/datamodel-create.png
+    :align: center
+
+Click on orange button to Add a Data Model, a pop-up will open, fill in the details related to Data Model.
+On clicking on Add button, you will be redirected to canvas for Adding DataModel Objects.
+
+.. image:: ../_images/datamodel/datamodel-canvas.png
+    :align: center
+
+For adding DataModel Object refer DataModel Object Reference documentation.
+
+.. toctree::
+    :maxdepth: 1
+
+    dataobject.rst
+
+Assign Data Model to Business Unit
+==================================
+
+.. image:: ../_images/datamodel/datamodel-assign.png
+    :align: center
+
+To assign a Data Model to a Business Unit, move to Business Unit tab and click on particular Business Unit card.
+This will open a side navigation for Business Unit, now click on edit and select the Data Model from DataModel drop-down and finally apply changes.
+
+Asset Landing Pages for Data Model Object
+=========================================
+
+For creating Asset Landing Pages refer to Asset Landing Page document.
+
+.. toctree::
+    :maxdepth: 1
+
+    ../admin/assetlanding.rst
+
+Results
+=======
+
+.. image:: ../_images/datamodel/datamodel-result.png
+    :align: center
+
+With that, we have created our Data Model.
diff --git a/docs/datamodel/objectCreation.rst → docs/datamodel/dataobject.rst b/docs/datamodel/objectCreation.rst → docs/datamodel/dataobject.rst
@@ -1,8 +1,8 @@
-################
-Object Reference
-################
+##########################
+DataModel Object Reference
+##########################
 
-This reference explains the different parts of datamodel object creation.
+This reference explains the different parts and operation related DataModel Object like creation, updation and deletion.
 
 |
 
@@ -12,11 +12,12 @@ Object Information
 .. image:: ../_images/datamodel/object-info.png
     :align: center
 
-The first page of the datamodel object creation stepper is for entering general object information. This includes:
+The first page of the DataModel Object creation stepper is for entering general object information. This includes:
 
 - **Object Name** - the name of the object. This must be unique within a datamodel.
 - **Object Description** - the optional description of the object.
 - **Object Type** - the type of object this is. This can be either ``Device`` or ``Asset``.
+- **Object Icon** - the icon of object. This can only be provided for ``Asset``.
 
 For our example, let's create a ``Developer`` object.
 
@@ -36,7 +37,7 @@ The Object Attributes section is where the attribute fields of this object are d
 - ``Heart Rate`` - the developer's heart rate. This could come from a fitness ``Device`` associated with the developer.
 - ``Location`` - the location of the developer. This could come from a mobile ``Device`` associated with the developer.
 
-The are of course just examples to illustrate how to use object attributes. We don't actually monitor the developers this closely (yet).
+These attributes are of course just examples to illustrate how to use object attributes. We don't actually monitor the developers this closely (yet).
 
 |
 
@@ -47,7 +48,7 @@ Object Relationships
 .. image:: ../_images/datamodel/object-relationships.png
     :align: center
 
-The Relationships section is where the datamodel object can define how it relates to other objects in the datamodel. 
+The Relationships section is where the DataModel Object can define how it relates to other objects in the DataModel.
 
 At this point, only a ``Parent`` relationship is supported, but more general relationships will be supported in the future.
 
@@ -62,10 +63,23 @@ Object Review
 .. image:: ../_images/datamodel/object-review.png
     :align: center
 
-The Review section allows us to review the datamodel object we have defined. 
+The Review section allows us to review the DataModel Object we have defined.
 
 For our example, this looks right for our ``Developer`` object. We will accept by clicking ``Submit`` to save our object to the datamodel.
 
+``NOTE`` : After adding DataModel Objects click on the orange tick button on buttom right corner, otherwise your changes will not be saved.
+
+|
+
+
+Object Saved Review
+===================
+
+.. image:: ../_images/datamodel/object-saved.png
+    :align: center
+
+The final DataObject Model view for Developer Object after submitting and saving changes of DataModel.
+
 |
 
 
@@ -75,4 +89,4 @@ Results
 .. image:: ../_images/datamodel/object-results.png
     :align: center
 
-With that, we have created our first small datamodel. This can be expanded to account for the devices associated with a ``Developer`` (macbook, fitness tracker, phone, etc...).
+With that, we have created our first small DataModel Object. This can be expanded to account for the devices associated with a ``Developer`` (macbook, fitness tracker, phone, etc...).
diff --git a/docs/index.rst b/docs/index.rst
@@ -57,7 +57,8 @@ Contents
    security/index
    admin/index
    reference/index
-   datamodel/objectCreation
+   datamodel/datamodel
+   datamodel/dataobject
    development/index
    gateway/index