Xuse User Guide: Actors

The actors.xml file contains the the complete list of actors pertinent to the project. Actors may represent users or they may represent systems. This file is used to declare the pertinent actors and provide a brief description about what they represent.

An Example XML based actors file is shown below:

example actors XML fragment

Before examining the different parts of the XML structure in detail it is worth visualising the transformed HTML result:

example actors HTML view

Note: traceability to use-case is derived from references in use-cases rather than in the actors file itself.

Actors XML reference

The following table explains the XML structure for the actors.xml file

Location/XPath Cdn. Description
xuse:actors 1 Container for all the actor entries.
xuse:actors/@model-version 1 Version of Xuse schemas that this file conforms to. This should not need to be changed and is typically used by the upgrade tool.
xuse:actors/xuse:actor 0..* Container for an actor entry.
xuse:actors/xuse:actor/xuse:stereotype 0..1 Allows the modeller to stereotype the actor. Valid values include:
  • system
  • person
xuse:actors/xuse:actor/xuse:description 1 Description text explaining what the actor represents.
xuse:actors/xuse:actor/xuse:title 1 Short title for the actor - this will be used in documentation.