Single Version Charts

There are two types of charts in the single-version charts, the ones that display data for the current artifact only, and the others that display data for the current artifact descendants.

When working with single-version data visualisation charts that considers the current artifact descendants, you need to define the set of descendant artifacts from which you want to display the data.

The following sections will help you understand the concept and syntax behind the Artifacts Set configuration.

Defining an Artifacts Set

The set of artifacts is defined by the use of embedded paths and path elements, as follows:

<chart id="TICKETS_SATUSES_DISTRIBUTION" type="SimplePie">
  <paths>
    <path scope="CHILDREN" targetArtefactTypes="TICKETS">
      <path targetArtefactTypes="TICKET" />
    </path>
  </paths>
  ...
</chart>

The paths element only accepts one path element as a direct sub-element. Then each path element can accept another unique path element as a sub-element.

This construction allows to recursively retrieve artifacts based on the resulting artifacts set of the parent path element.

The path element supports the following attributes:

  • scope (mandatory), the perimeter of the artifacts to consider. Accepted values are:

    • DESCENDANTS allows to consider all children of the current artifact and their descendants. Accepts the following additional attributes when defined:

      • targetArtefactTypes (mandatory) defines the types of artifacts this filter applies to. For more information about artifact types, consult Artifact Types.

      • excludingTypes allows refining targetArtefactTypes to exclude certain types that may have been included via an alias.

    • CHILDREN allows to consider only the direct children if the current artifact.

      • targetArtefactTypes (mandatory) defines the types of artifacts this filter applies to. For more information about artifact types, consult Artifact Types.

      • excludingTypes allows refining targetArtefactTypes to exclude certain types that may have been included via an alias.

    • LINKS allows to consider all artifacts linked to the current artifact. Accepts the following additional attributes when defined:

      • linkType allows to filter artifacts linked to the current artifact according to their link type. For more information about links, refer to Artifact Links.

      • linkDirection (optional, default: OUT) is used to specify the link direction to consider. Accepted values are:

        • OUT to consider links from the current artifact towards other artifacts

        • IN to consider links from other artifacts towards the current artifact

Filtering an Artifacts Set

The use of a where clause allows you to filter out artifacts based on a measure, indicator or textual information.

Squore checks if the metric/indicator/information specified is within the defined bounds for the artifact, in order to know if it should be included or not in the artifacts set.

The where clause is used as follows:

<chart id="TICKETS_SATUSES_DISTRIBUTION" type="SimplePie">
  <paths>
    <path scope="CHILDREN" targetArtefactTypes="TICKETS">
      <path targetArtefactTypes="TICKET">
        <where>
          <indicator id="STATUS" levels="TICKET_CLOSED;TICKET_IMPLEMENTING" />
          <measure id="AGE" bounds="[1;10]" />
          <info id="HANDLER" patterns="Harry*;Nadine" />
        </where>
      </path>
    </path>
  </paths>
  ...
</chart>

The where element accepts the following sub-elements:

  • measure to filter based on a measure. Following attributes are supported:

    • id (mandatory) is the entity identifier in the analysis model.

    • values|bounds (mandatory) is respectively, a semicolon-separated list of values or an interval, to test for the specified metric.

    • invert (optional, default: false) allows checking for the invert of a condition when set to true.

  • indicator to filter based on an indicator. Following attributes are supported:

    • id (mandatory) is the entity identifier in the analysis model.

    • levels (mandatory) is a semicolon-separated list of scale levels to test for the specified metric.

    • invert (optional, default: false) allows checking for the invert of a condition when set to true

  • info to filter based on an information. Following attributes are supported:

    • id (mandatory) is the entity identifier in the analysis model.

    • values|patterns (mandatory) is a semicolon-separated list of respectively, values or wildcard patterns, to test for the specified metric.

    • invert (optional, default: false) allows checking for the invert of a condition when set to true.