Traceability Dashboard

Below are the pre-requisites to be setup in order to view Traceability dashboard .

• Copy sample datamodel.json from https://infra.cogdevops.com:8443/#browse/browse:docroot:insights_install%2Fdatamodel and place it under INSIGHTS_HOME folder.     

          datamodel.json file has structured format and having collection of JsonObject as below.(Sample Ref)

          {
          "JIRA": {
          "uuid" :"uuid",
          "order" :1,
          "toolName": "toolName",
          "toolstatus": "jiraStatus",
          "timestamp": "inSightsTime",
          "inSightsTimeX":"inSightsTimeX",
          "uptool":["null"],
          "downtool":["GIT"],
          "uifilter":["jiraKey","projectName"],
           },
          "GIT": {
          "uuid":"uuid",
          "order" :2,
          "inSightsTimeX":"inSightsTimeX",
          "toolName": "toolName",
          "toolstatus": "Committed",
          "author": "gitAuthorName",
          "timestamp": "inSightsTime",
          "uptool":["JIRA"],
          "downtool":["JENKINS"],
          "gitCommiTime":"gitCommiTime",
          "messages" : [
           {"Message":"Commit Information - Commits performed over a period of {0} by {1} unique developer(s)","Operation":"TIMEDIFF","OperandName":"timestamp","OperandValue":"}
            ],
          "uifilter":["commitId"]
         }

       datamodel.json file is divided into three sections :

1. Pipeline Properties . (Mandatory Properties)

   1. uuid : uuid of the neo4j node.

   2. order : the order needs to be set to each tool in order to maintain sequence in pipeline view the order is integer value for ex( order:1,2,3....etc).

   3. toolName:  toolname of the node .
   4. toolstatus : toolstatus of the node.
   5. timestamp : Insights Time is epoc format ,  for ex ( "timestamp": "inSightsTime") 
   6. uptool:   JsonArray maintaining parent relationship for ex (for JENKINS uptool can be GIT and is mentioned as uptool:["GIT"].
   7. downtool: JsonArray maintaining child relationship for ex (for JENKINS downtool can be SONAR and RUNDECK and is mentioned as downtool:["SONAR","RUNDECK"].
   8. inSightsTimeX: this is Insights Time.
   9. author: auther name (Mandatory for the SCM category optional for other categories)
2. Summary Info Properties (Mandatory Property for summary information display )
   1. message : array of message objects having 4 properties.
      1. Message : this is standard message shown on the screen , currently 3 standards messages are being supported.
         1. Commit Information - Commits performed over a period of {0} by {1} unique developer(s) (To be part of any SCM tool)
         2. Build Information - {0} Passed {1} Failed (To be part of any build tool)
         3. Deployment - {0} Successful Deployments {1} Failed Deployments (To be part of any deployment tool) 
      2. Operation : this is aggregation function name currently there are 2 operations supported .
         1. SUM : this operation is used to sum based on provided parameters.
         2. TIMEDIFF : this operation is used to calculate the diff in timestamp with provided input (To be part of SCM category)
      3. OperandName: this is the name of the property in datamodel on which the operation is performed for ex( if operation is TIMEDIFF and OperandName is timestamp then TIMEDIFF is calculated on timestamp )
      4. OperandValue: this is mandatory field for the SUM operation for ex ( Message Clause is : Deployment - {0} Successful Deployments {1} Failed Deployments and Operation is SUM and OperandName is Success then it is calculate the no of nodes having Success status and it value gets replaced in first place {0} and Total - Success nodes gets replaced in {1} 

1. UIFilter Properties (Mandatory Properties displayed in dropdown ) 
   1. uifilter : Array of neo4j properties for ex (uifilter for the JENKINS could be "uifilter":["buildNumber","projectName"] meaning buildNumber and projectName is displayed on the UI dropdown

• Steps to follow on UI
  1. From the first dropdown select the tool name .(Jira as selected below)
  2. From the second drop down select the property for the tool name (this dropdown is loaded from the datamodel uifilter property)(jiraKey as selected below)
  3. paste the value of the selected property (LS-9974351736 as pasted below)
  4. click on the submit button to get the pipeline view