Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section will explain the Kiuwan metrics into detail. 

Contents

Table of Contents

Introduction

Go to Model Management > Metrics to access the metrics section. 

Image Added

This section shows all the available metrics for current user and which of them are active in the current model version. Only Kiuwan metrics are available and they are not editable, but users can tag metrics as they need. All available metrics are mandatory: when a model is published all of them will be automatically added to the current model. This way your analyses will contain as much information about metrics as Kiuwan can give you.
Image Modified

Metrics Section

Filters

This is the first part

...

of the

...

metrics section, where you can filter which metrics are shown.
Image Modified
The default filters are:

NameDescription
Active

...

 Shows the active metrics.
Name or description

...

Shows the metrics which match with the pattern written. This pattern is contained in the name or description of the metric and is highlighting in the metrics tree. 
Language

...

 Shows the metrics which match the selected language.
Category

...

 Shows the metrics which match the selected category.
Tag

...

 Shows the metrics that

...

contain one or more tags. 
More

...

 Contains more advanced filters:
  • Metric code

...

  •  filter.

...

  •  Show the metrics whose metric identifier matches the specified pattern.
  • Engine version

...

  •  filter.

...

  •  Show the metrics which match with the selected Kiuwan engine version.
  • Default configuration

...

  •  filter.

...

  •  Shows the metrics which

...

  • have the default configuration.


These filters can be combined one with each other. When activating more than one filter, only metrics that match both filters will be shown.
Each time the filter is changed, the metric counter under the filter section will be updated according to the specified filter. 

Metrics tree

...

The metrics are shown in this next section

Image Modified

...


The metrics are shown in the form of a tree hierarchy. Nodes can be collapsed and expanded with the

...

Expand all

...

and

...

Collapse all

...

buttons. By default, all metrics are collapsed. 
Image Modified
Each metric shows its activate status, its name, its category and the technologies that it implements.

...

 Hover the mouse over the concrete language item

...

in a metric to view the languages supported by the metric.

Image Modified
 

...

Hover the mouse on the ? icon to view details of some of

...

the properties

...

of each metric.

Image Modified

Metrics details

...

Click the name of a metric

...

to show the metric details window

...

.
This window shows the full information of the selected metric. This information is separated

...

into different sections as described below.

Image Modified

Metric definition

...

It contains basic information about the metric

...

Name and full description of the metric explaining how it

...

operates and the programming languages it applies to.

Image Modified

Thresholds

...

It contains indicative information about which metric values are considered: Good, Bad or Regular. Thresholds can be defined by technology.

 
Image Modified

Tags

Metrics can be tagged. The field Custom tag is editable and you can add your own tags or use Kiuwan's.

Parameters, Category, and References

...

NameDescription
Category It shows 

...

the category the metric belongs to. This value is not editable.
Range and Value meaning

...

It shows the valid values for the metric and how to know when a value is good for your application. These values aren't editable.
References

...

It shows the documentation references

...

for the metric.

...

 These values aren't editable.


Image Modified

Code examples

This section shows the value obtained when the metric is applied to the code examples provided. A code example is provided for each supported technology.

Image Modified

Details of the metric

...

It shows advanced information fields. Most of them related to the internal implementations of the metric:

  • Owner field.
  • Metric code field. 
  • Engine field.
  • Engine version field.
  • Metric version field. 
  • Creation date field.
  • Last modification date field.

Image Modified

In the Implementations section, you can choose one of the technologies supported by the metric and to its implementation code,

...

Java class, and description.

Image Modified

In the Internal parameters section, the name-value pairs of the parameters used internally by the metric are shown.

Image Modified

None of these fields are editable.