Artefact Types

You can define any artefact type in your model by declaring them in the artefactTypes attribute of your analysis model's RootIndicator , as shown below. The following definition of the ROOT main indicator declares the types APPLICATION, FILE, CLASS, FUNCTION, REQUIREMENT, TEST_PLAN, TEST_SUITE and TEST:

<RootIndicator 
  artefactTypes="APPLICATION;FILE;CLASS;FUNCTION;REQUIREMENT;TEST_PLAN;TEST_SUITE;TEST"
  indicatorId="ROOT" />

In addition, you can define aliases to group types of artefacts together to use later when defining metrics in your analysis model. The ArtefactType definition below groups the artefacts defined above into CODE and DOCUMENT aliases:

<ArtefactType id="CODE" heirs="APPLICATION;FILE;CLASS;FUNCTION" />
<ArtefactType id="DOCUMENT" heirs="REQUIREMENT;TEST_PLAN;TEST_SUITE;TEST" />

This means that the long artefact declaration above can be rewritten as follows:

<RootIndicator artefactTypes="CODE;DOCUMENT"
  indicatorId="ROOT" />

Note

You can use aliases everywhere in your configuration, except in properties files.

You can also use the ArtefactType element with a manual attribute to declare that some artefacts can be added manually by the user, as shown below:

<ArtefactType id="TEST_SUITE" parents="APPLICATION;TEST_SUITE;TEST_PLAN" manual="true" />
<ArtefactType id="TEST" parents="TEST_SUITE" manual="true" />
<ArtefactType id="TEST_PLAN" parents="APPLICATION" manual="true" />
<ArtefactType id="REQUIREMENT" parents="APPLICATION" manual="true" />

Manual artefacts can be added by users with the required permissions via a context menu in the Artefact Tree