1E 23.7 (SaaS)

A response visualization definition must be provided in each instruction definition that requires a custom response visualization. This is because it is tightly coupled to instruction definition schema. The configuration is JSON based.

Template Configuration Properties

{
  "Name": "default",
  "TemplateConfigurations": [
    {
      Configuration for chart 1
    },
    {
      Configuration for chart 2
    }
  ],
  "PostProcessors": [
    {
      PostProcessor 1 definition
    },
    {
      PostProcessor 2 definition
    }
  ]
}

From the JSON above we can see it has three properties.

Example

Example

{
  "Name": "default",
  "TemplateConfigurations": [
    {
      "Id": "column1",
      "Title": "15 most common new process starts",
      "Type": "Column",
      "X": "ExecutableName",
      "Y": "Count",
      "PostProcessor": "processingFunction",
      "Size": 1,
      "Row": 1
    }
  ],
  "PostProcessors": [
    {
      "Name": "processingFunction",
      "Function": "ProcessSingleSeries('ExecutableName', 'Count', '15', 'Count', 'false')"
    }
  ]
}

This property is the name of a template. Tachyon comes with one default template named "default". At the moment, only "default" template is available and that template handles various types of charts and graphs. In future it would be possible to create custom templates.

This property contains an array of one or more template configurations. Each configuration defines how the specified template will be used, which aggregated response columns are used, and which processors are used to render the specified visualization. At this time "default" is the only supported type of template, which provides an array of chart and graph types. Therefore, each definition describes what chart or graph can be created, which response columns are plotted, where the chart will be positioned and also how its data is to be processed using a PostProcessor.

Template configuration example

{
  "Id": "TopLeft",
  "Title": "15 most common new process starts",
  "Type": "Column",
  "X": "ExecutableName",
  "Y": "Count",
  "PostProcessor": "processingFunction",
  "Size": 1,
  "Row": 1
}

This property contains an array of processor definitions. Each definition specifies the configuration of a single processor. The same processor can be used by multiple visualizations. Each response processor prepares data to be consumed by a visualization and must produce data in a format expected by that visualization. V isualizations expect all the data preparation and formatting to be done by the processors and they will not do any themselves. They will simply take the processor output and attempt to use it directly as their data source. In case of charts this means attempting to plot chart specified in the visualization using the data provided by the processor.

Please note that Function and Script are mutually exclusive.

Built-in PostProcessor example

{
  "Name": "processingFunction",
  "Function": "ProcessSingleSeries('ExecutableName', 'Count', '15', 'Count', 'false')"
}

Script based PostProcessor example

{  
  "Name": "processingFunction",
  "Script": "var xaxis = \"ProcessName\"; 
          var yaxis = \"Average\"; 
          var yaxis = \"Average\";
          var items = responses.Select(r => { var obj = new JObject(); obj.Add(xaxis, Convert.ToString(r.Values[\"ProcessName\"])); obj.Add(yaxis, (Convert.ToInt64(r.Values[\"Sum\"]) / Convert.ToInt64(r.Values[\"Count\"]))); return obj; }).ToList();
          var result = new JObject();
          result.Add(\"Name\", \"Average CPU Usage (%)\");
          result.Add(\"Total\", 0);
          result.Add(\"Items\", JToken.FromObject(items));
          var cake = new List<JObject>();
          cake.Add(result);
          return JsonConvert.SerializeObject(cake);"
}

In the above example, the instruction that has aggregation schema with 3 columns: "Sum", "Count" and "ProcessName".