Update ModelCategory.rst

source/ModelCategory.rst

@@ -223,6 +223,8 @@ for the Node. The Edit Settings are categorized as follows:
 
 6. Conditional Formatting 
 
+7. Secondary KPI
+
 
 
 General
@@ -334,8 +336,7 @@ For other options of calculation method, you can refer the link: https://valq.co
 
 On selecting 'Formula' and clicking on the formula field, you will be able to see a dropdown of the formulas that are supported. For a list of formulas that are available in valQ, you can refer to the link :doc:`Functions`
 
-Template Nodes selection in Calculation Method
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+**Template Nodes** 
 
 Also you can create a Template Node for the already existing Node. It
 is very specific that the Template Nodes should not map the Parent
@@ -420,8 +421,7 @@ Pop up screen.
 
     Pop up screen
 
-Composite Node Display
-~~~~~~~~~~~~~~~~~~~~~~
+**Composite Node Display**
 
 A Node in a tree can now be added with a maximum of two composite nodes which can be taken from any nodes. 
 For our example, the below Figure shows the Tree structure with several nodes.
@@ -632,6 +632,95 @@ and based on that condition, the status bar for the Node Revenue is green color
 
 Now set the option to "Hidden: No Rule will be applied to this Node". You can observe that no range values can be provided for the Conditional Formatting and since there will be no status color for that Node being simulated. 
 
+Secondary KPIs
+~~~~~~~~~~~~~~~~~~~~
+
+Secondary KPIs helps user to aggregate and visualize additional or alternate KPI values in the node widget. 
+Specifically, in a model with two data series, these are the set of secondary metrics captured under the primary value of the node
+
+.. figure:: _static/SecKPI.1.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
+As a default, there are three secondary values displayed for a dual series data in the following order
+i. Full Period Variance between baseline and comparison metric (in % and absolute values)
+ii.	Baseline metric value for the first period in the series 
+iii. Variance for the first period between baseline and comparison metric (in % and absolute values) 
+
+.. figure:: _static/SecKPI.2.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
+Secondary KPI option lets users to customize these secondary values or metric according to their preference 
+
+Users can achieve this using:
+I.	Secondary KPI option based on Formulas
+II.	Secondary KPI option based on Template
+
+I.	Secondary KPI option based on Formulas
+
+In the below model screenshot, the user can display the data value from Operating Profit %’ and ‘Operating Expense Ratio’ as Secondary KPI values to the TOP node ‘Operating profit’.
+
+.. figure:: _static/SecKPIF.1.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
+Under the 'Operating Profit' node setting's 'Secondary KPI' ribbon, user needs to select the 'Formula' button and fill-in the label name and the custom formula for his additional Secondary KPIs
+
+.. figure:: _static/SecKPIF.2.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
+.. figure:: _static/SecKPIF.3.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
+Upon completing, the user can see ‘Operating Profit %’ and ‘Ops Expense Ratio’ values displayed as Secondary KPI values to ‘Operating profit’
+
+.. figure:: _static/SecKPIF.4.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
+
+II.	Secondary KPI option based on Template
+
+In the model, user can display ‘Contribution’ of each of the child nodes Water, Beverages, and Others to their parent node Gross Profit. 
+User should define ‘Contribution’ as a Formula in one of the nodes and call them out for ‘Contribution’ calculation using the Template option at the other nodes.
+
+.. figure:: _static/SecKPIT.1.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
+In this example, user can define the formula in 'Water' node under the node setting's Secondary KPI by selecting 'Formula' button and defining the 'Custom Formula'
+Upon completion, 'Contribution %' is displayed as a Secondary value of the node widget.
+
+.. figure:: _static/SecKPIT.2.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
+To borrow this formula on other nodes, user can fo into the Secondary KPI setting of the 'Beverages' node, select the 'Template' button, and choose to display the same formula as the 'Water' node.
+User can instantly see the corresponding 'Contribution %' at the 'Beverage' node.
+
+.. figure:: _static/SecKPIT.3.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
+Similarly, following the same steps for the 'Other' node helps the user to instantly visualize ‘Contribution %’ for the all the child nodes to Gross Profit
+
+.. figure:: _static/SecKPIT.4.png
+    :align: center
+    :width: 1000
+    :alt: alternate text
+
 Create a Simple Model
 ---------------------