On this page

$project is a project reference enabling a template to return the project information.

$project.getName()

Returns a project name.


NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project name.

$project.getTitle()

Gets a project title.



NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project title.

$project.getFileName()

Gets a project filename.


NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project filename.

$project.getExtension()

Gets a project filename extension.


NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project filename extension.

$project.getDirectory()

Get a project directory name.


NameTypeDescription
Parameter(s)---
Return-java.lang.StringA project directory name.

$project.getVersionList()

Returns a list of version information from an open Server project.


NameTypeDescription
Return-java.util.List<ProjectVersion>A list of com.nomagic.magicdraw.magicreport.tools.ProjectsVersion.
Version information consists of the following attributes:
  • comment: a version committed comment
  • date: a committed date
  • dateAsString: a committed date as text
  • number: a committed version
  • numberAsString: a committed version as text
  • user: a committer’s name
  • version: a version object that can be com.nomagic.teamwork.common.projects.Version for Teamwork project or com.nomagic.magicdraw.esi.project.project.IEsiVersionDescriptor for Teamwork Cloud project.


Following is the sample code.

Current version : $project.version
All version:
----------------
#foreach ($version in $project.versionList)
Date : $version.date
Number : $version.number
Number as String : $version.numberAsString
User : $version.user
Comment : $version.comment
----------------
#end

$project.getType()

Returns a file type. A file type is one of the following values:

  • 0 – UNDEF
  • 2 – XML_NATIVE
  • 3 – UNSIYS_XMI

NameTypeDescription
Return-intThe value of a file type.

$project.getDiagrams()

Returns all existing diagrams stored in a particular project.


NameTypeDescription
Return-java.util.CollectionA collection of diagram instances.

$project.getDiagrams(type)

Returns existing diagrams of a given type stored in a particular project.


NameTypeDescription
Parameter(s)typejava.lang.StringA diagram type.
Return-java.util.CollectionA collection of diagram instances.



#set($classDiagram = $project.getDiagrams("Class Diagram"))
#foreach($cl in $classDiagram)
$cl.name
#end



  • “Class Diagram” is a diagram type

$project.getPresentationDiagrams()

Returns all existing presentation diagrams stored in a particular project.


NameTypeDescription
Return

-

java.util.CollectionA collection of diagram views.


$project.getPresentationDiagrams(type)

Returns all existing presentation diagrams of a given type stored in a particular project.


NameTypeDescription
Parameter(s)typejava.lang.StringA diagram type.
Return-java.util.CollectionA collection of diagram views.
#set($classDiagram = $project.getPresentationDiagrams("Class Diagram"))
#foreach($cl in $classDiagram)
$cl.name
#end


  • “Class Diagram” is a diagram type.

$project.isRemote()

Returns the remote or non-remote state of a project.


NameTypeDescription
Return-java.lang.BooleanReturn true if a
project is a remote
project, otherwise false.

$project.isDirty()

Returns true if that particular project was modified after it had been saved or loaded.


NameTypeDescription
Return

-

java.lang.BooleanReturn true if a
project was modified
after it had been
saved/loaded,
otherwise false.

$project.getElementByID(id)

Returns an element with a given ID.

 NameTypeDescription
Parameter(s)IDjava.lang.StringAn element ID.
Return-com.nomagic.magicdraw.uml.BaseElementAn element with a given ID or null
if the element with such ID is not
registered in the project.
#set($ele = $project.getElementByID("_9_0_62a020a_1105704887361_983947_8206"))
$ele.name
#ele.humanType


  • “_9_0_62a020a_1105704887361_983947_8206” is the element’s ID number.

$project.getAllElementId()

Returns a collection of all element IDs in a project.


NameTypeDescription
Return-java.util.CollectionA collection of all element IDs in a project.

$project.getXmiVersion()

Returns the XMI version of a project.


NameTypeDescription
Return-intAn XMI version.

$project.getVersion()

Return a project version number.


NameTypeDescription
Return-longA project version number.

$project.getModel()

Returns a model (the root container of all model structures).


NameTypeDescription
Return-com.nomagic.uml2.ext.magicdraw.auxiliaryconstructs.mdmodels.ModelA model.

$project.getModel() is deprecated since MagicDraw 18.2, please use $project.getPrimaryModel() instead

$project.getPrimaryModel()

Returns the primary (main) model of the project (not including the ones from modules (attached projects)).


NameTypeDescription
Return-com.nomagic.uml2.ext.magicdraw.classes.mdkernel.PackageThe primary model
of the project.


$project.getAllModels()

Returns a list of models in the project (the primary model of the project and all the models of the modules(attached projects)).


NameTypeDescription
Return-Java.util.ListA list of
models.

$project.getModuleList(auxiliary)

Returns a list of used server and local modules from a server project.

NameTypeDescription
Parameter(s)

auxiliary

booleanReturns auxiliary resources only if this value is True.
Default is False.
Return-java.util.CollectionA list of com.nomagic.magicdraw.core.modules.ModuleDescriptor


$project.getSharedModule(module)

Returns a list of shared modules from a specified module.

 NameTypeDescription
Parameter(s)modulecom.nomagic.magicdraw.core.modules.ModuleDescriptorA module.
Return-java.util.CollectionA list of com.nomagic.magicdraw.core.modules.ModuleDescriptor.


$project.getServerModule(auxiliary)

This function returns the list of used server modules as well as auxiliary resources.


NameTypeDescription
Parameter(s)auxiliarybooleanReturns auxiliary resources when this value is True.
Default is false.
Return-java.util.CollectionA list of com.nomagic.magicdraw.core.modules.ModuleDescriptor.


$project.getLocalModule(auxiliary)

This function returns a list of used local modules as well as auxiliary resources.


NameTypeDescription
Parameter(s)auxiliarybooleanReturns auxiliary resources when this value is True.
Default is false.
Type-java.util.CollectionA list of com.nomagic.magicdraw.core.modules.ModuleDescriptor.


$project.getAuxiliaryResource()

This function returns a list of auxiliary resources.


NameTypeDescription
Type-java.util.CollectionA list of com.nomagic.magicdraw.core.modules.ModuleDescriptor.
#foreach ($module in $project.getModuleList())
name				: $module.representationSpring
description			: $module.description
version				: $module.version
required version	: $module.requiredVersion
shared module		: 
#foreach ($child in $project.getSharedModule($module)) 
- $child.representationString
#end
#end
  • $module is the module from Teamwork Server.