On this page

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

$project.getName()

Returns a project name.

	Name	Type	Description
Parameter(s)	-	-	-
Return	-	java.lang.String	A project name.

$project.getTitle()

Gets a project title.

	Name	Type	Description
Parameter(s)	-	-	-
Return	-	java.lang.String	A project title.

$project.getFileName()

Gets a project filename.

	Name	Type	Description
Parameter(s)	-	-	-
Return	-	java.lang.String	A project filename.

$project.getExtension()

Gets a project filename extension.

Note

This function is only for local projects.

	Name	Type	Description
Parameter(s)	-	-	-
Return	-	java.lang.String	A project filename extension.

$project.getDirectory()

Get a project directory name.

Note

This function is only for local projects.

	Name	Type	Description
Parameter(s)	-	-	-
Return	-	java.lang.String	A project directory name.

$project.getVersionList()

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

	Name	Type	Description
Return	-	java.util.List<ProjectVersion>	A list of com.nomagic.magicdraw.magicreport.tools.ProjectsVersion.

$project.getDiagrams()

Returns all existing diagrams stored in a particular project.

	Name	Type	Description
Return	-	java.util.Collection	A collection of diagram instances.

$project.getDiagrams(type)

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

	Name	Type	Description
Parameter(s)	type	java.lang.String	A diagram type.
Return	-	java.util.Collection	A collection of diagram instances.

Sample code

#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.

	Name	Type	Description
Return	-	java.util.Collection	A collection of diagram views.

$project.getPresentationDiagrams(type)

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

	Name	Type	Description
Parameter(s)	type	java.lang.String	A diagram type.
Return	-	java.util.Collection	A collection of diagram views.

Sample code

#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.

	Name	Type	Description
Return	-	java.lang.Boolean	Return 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.

	Name	Type	Description
Return	-	java.lang.Boolean	Return true if a project was modified after it had been saved/loaded, otherwise false.

$project.getElementByID(id)

Returns an element with a given ID.

	Name	Type	Description
Parameter(s)	ID	java.lang.String	An element ID.
Return	-	com.nomagic.magicdraw.uml.BaseElement	An element with a given ID or null if the element with such ID is not registered in the project.

Sample code

#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.

	Name	Type	Description
Return	-	java.util.Collection	A collection of all element IDs in a project.

$project.getXmiVersion()

Returns the XMI version of a project.

	Name	Type	Description
Return	-	int	An XMI version.

$project.getVersion()

Return a project version number.

	Name	Type	Description
Return	-	long	A project version number.

$project.getModel()

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

	Name	Type	Description
Return	-	com.nomagic.uml2.ext.magicdraw.auxiliaryconstructs.mdmodels.Model	A 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)).

	Name	Type	Description
Return	-	com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Package	The 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)).

	Name	Type	Description
Return	-	Java.util.List	A list of models.

-------

$project.getModuleList()

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

	Name	Type	Description
Return	-	java.util.Collection	A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule

$project.getModuleList(includeAuxiliary)

Returns a list of used server and local modules as well as auxiliary resources from a current project.

	Name	Type	Description
Parameter(s)	includeAuxiliary	boolean	Returns module including auxiliary resources when this value is True. Default is false.
Return	-	java.util.Collection	A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule

$project.getSharedModule()

Returns a list of shared modules from a current project.

	Name	Type	Description
Return	-	java.util.Collection	A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule

$project.getSharedModule(projectModule)

Returns a list of shared modules from a specified project module.

	Name	Type	Description
Parameter(s)	projectModule	com.nomagic.magicdraw.magicreport.tools.ProjectModule	A project module.
Return	-	java.util.Collection	A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule

$project.getServerModule()

This function returns the list of used server modules.

	Name	Type	Description
Return	-	java.util.Collection	A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule

$project.getServerModule(includeAuxiliary)

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

	Name	Type	Description
Parameter(s)	includeAuxiliary	boolean	Returns server modules including auxiliary resources when this value is True. Default is false.
Return	-	java.util.Collection	A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule

$project.getLocalModule()

This function returns the list of used local modules.

	Name	Type	Description
Return	-	java.util.Collection	A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule

$project.getLocalModule(includeAuxiliary)

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

	Name	Type	Description
Parameter(s)	includeAuxiliary	boolean	Returns local modules including auxiliary resources when this value is True. Default is false.
Return	-	java.util.Collection	A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule

$project.getAuxiliaryResource()

This function returns a list of auxiliary resources.

	Name	Type	Description
Return	-	java.util.Collection	A collection of com.nomagic.magicdraw.magicreport.tools.ProjectModule

ProjectVersion

Full class name is com.nomagic.magicdraw.magicreport.tools.ProjectVersion
ProjectVersion is a class that represents some version of the project or module. It contains date, user, and number, etc.
ProjectVersion contains following properties:

Property	Return Type	Description
comment	java.lang.String	Return a version committed comment
date	java.util.Date	Return a committed date
dateAsString	java.lang.String	Return a committed date as text
number	long	Return a committed version
numberAsString	java.lang.String	Return a committed version as text
user	java.lang.String	Return a committer’s name
version	java.lang.Object	Return 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.
tags	java.util.List<java.lang.String>	Return all tags

Sample code

Sample code

Current version : $project.version
All version:
#foreach ($version in $project.getVersionList())
	Date : 				$version.date
	Number : 			$version.number
	Number As String : 	$version.numberAsString
	User : 				$version.user
	Comment : 			$version.comment
	Tags: 	#foreach($tag in $version.tags) 
						- tag
			#end
---
#end

ProjectModule

Full class name is com.nomagic.magicdraw.magicreport.tools.ProjectModule
ProjectModule is a wrapper Class of an attached project (com.nomagic.ci.persistence.IAttachedProject) that represents a special kind of project that is used as a component in current project.
Example properties and methods of ProjectModule:

Property / Method	Return Type	Description
representationString	java.lang.String	Return user friendly representation string about the module
description	java.lang.String	Return project description of the module.
version	long	Return version number of the module.
requiredVersion	java.lang.String	Return required version of the module. This property works for Teamwork Server project. It will return -1 when module is latest version and required version is not set.
remoteID	java.lang.String	Return remote id for the module
URI	java.net.URI	Convert EMF uri to java.net.URI
versionList	java.util.List<com.nomagic.magicdraw.magicreport.tools.ProjectVersion	Return list of version descriptors of the module
isRemote()	boolean	Check if the module is remote - from Teamwork server or TW Cloud.

Sample code

Sample code

#foreach($module in $project.getModuleList())
	Name : $module.representationString
	Description : $module.description
	Version : $module.version
	RemoteID : $module.remoteID
	URI : $module.URI 
#if($module.isRemote())
#set($version = $module.projectVersion)
Current module version :
date : $version.date
number : $version.number 
numberAsString : $version.numberAsString
user : $version.user
comment : $version.comment
tags: #foreach($tag in $version.tags) - $tag #end All
module versions : #foreach($version in $module.versionList)
date : $version.date
number : $version.number
numberAsString : $version.numberAsString
user : $version.usercomment : $version.comment 
tags: #foreach($tag in $version.tags) - $tag #end ---------- #end #end 
Shared module: #foreach ($child in $project.getSharedModule($module)) - 
$child.representationString
#end
#end

Content

Space Tools

$project.getName()

$project.getTitle()

$project.getFileName()

$project.getExtension()

$project.getDirectory()

$project.getVersionList()

$project.getDiagrams()

$project.getDiagrams(type)

$project.getPresentationDiagrams()

$project.getPresentationDiagrams(type)

$project.isRemote()

$project.isDirty()

$project.getElementByID(id)

$project.getAllElementId()

$project.getXmiVersion()

$project.getVersion()

$project.getModel()

$project.getPrimaryModel()

$project.getAllModels()

$project.getModuleList()

$project.getModuleList(includeAuxiliary)

$project.getSharedModule()

$project.getSharedModule(projectModule)

$project.getServerModule()

$project.getServerModule(includeAuxiliary)

$project.getLocalModule()

$project.getLocalModule(includeAuxiliary)

$project.getAuxiliaryResource()

ProjectVersion

ProjectModule

Content

Space Tools

Breadcrumbs

Project tool

$project.getName()

$project.getTitle()

$project.getFileName()

$project.getExtension()

$project.getDirectory()

$project.getVersionList()

$project.getDiagrams()

$project.getDiagrams(type)

$project.getPresentationDiagrams()

$project.getPresentationDiagrams(type)

$project.isRemote()

$project.isDirty()

$project.getElementByID(id)

$project.getAllElementId()

$project.getXmiVersion()

$project.getVersion()

$project.getModel()

$project.getPrimaryModel()

$project.getAllModels()

$project.getModuleList()

$project.getModuleList(includeAuxiliary)

$project.getSharedModule()

$project.getSharedModule(projectModule)

$project.getServerModule()

$project.getServerModule(includeAuxiliary)

$project.getLocalModule()

$project.getLocalModule(includeAuxiliary)

$project.getAuxiliaryResource()

ProjectVersion

ProjectModule