TOPCASED

TPC-SPECEDDEPLOYMENT

Page 1/13

DEPLOYMENT DIAGRAM SPECIFICATIONS

1.0 Author(s) Name Jacques LESCOT Checked by Approbation

Compagny Anyware Technologies Department ST Date Visa

Summary

Deployment Diagram Specifications of the UML Editor

Attention : la responsabilit des entreprises et des organismes ayant particip l'laboration de ce document ne peut en aucun cas tre engage en cas de dommages ou de pertes rsultant de l'utilisation ou de l'exploitation des informations qui y sont contenues. Disclaimer : Contractors participating to this report shall incur no liability whatsoever for any damage or loss which may result from the use or exploitation of information and/or Rights contained in this report. 07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 2/13

Table of Contents
1 Preface.............................................................................................................................. 3 1.1 Approbation list.......................................................................................................... 3 1.2 Table of versions........................................................................................................ 3 1.3 Table of references and applicable documents......................................................... 3 1.4 Table of abbreviations................................................................................................ 3 1.5 Glossary..................................................................................................................... 3 2 Goal of this document....................................................................................................... 5 3 Conception........................................................................................................................ 6 3.1 Package..................................................................................................................... 6 3.2 Node, Device and ExecutionEnvironment.................................................................. 7 3.3 Artifact........................................................................................................................ 8 3.4 DeploymentSpecification............................................................................................ 8 3.5 Deployment................................................................................................................ 9 3.6 Manifestation............................................................................................................ 10 3.7 Dependency............................................................................................................. 10 3.8 CommunicationPath................................................................................................. 11 4 Conclusion....................................................................................................................... 12

Index of Illustrations

07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 3/13

1 Preface
1.1 Approbation list
Entity Name Date Approbation Observations

1.2 Table of versions

Version Date Description & rationale of modifications Creation of the document Sections modified Whole document

Version 1.0 25/07/06

1.3 Table of references and applicable documents

Reference Title & edition Author or editor Year

1.4 Table of abbreviations

Abbreviation Description

1.5 Glossary

07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 4/13

Term

Description

07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 5/13

2 Goal of this document

This document is the design document of the Deployment Diagram of the UML2 graphical editor in the TOPCASED project. It aims to provide a first draft for a further implementation of this diagram. It will describe graphical objects that will be available in the Palette of the diagram, model objects associated and interactions between them. Overview The Deployments package specifies a set of constructs that can be used to define the execution architecture of systems that represent the assignment of software artifacts to nodes. Nodes are connected through communication paths to create network systems of arbitrary complexity. Nodes are typically defined in a nested manner, and represent either hardware devices or software execution environments. Artifacts represent concrete elements in the physical world that are the result of a development process. The Deployment package supports a streamlined model of deployment that is deemed sufficient for the majority of modern applications. Where more elaborate deployment models are required, it can be extended through profiles or meta models to model specific hardware and software environments. Artifacts The Artifacts package defines the basic Artifact construct as a special kind of Classifier. Nodes The Nodes package defines the concept of Node, as well as the basic deployment relationship between Artifacts and Nodes. Component Deployments The ComponentDeployments package extends the basic deployment model with capabilities to support deployment mechanisms found in several common component technologies.

07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 6/13

3 Conception
Warn against : For each graphical element of the editor, it is not necessary associated with a model object. In consequence, a graphical object is (choice of) the visual representation of :

a model object many model objects a specific behaviour of the model an element purely informative, with no link with the model.

3.1 Package
Model description : A package is used to group elements, and provides a namespace for the grouped elements. This is the root model object of a Deployment Diagram, as this is the only one model objects that may be the root for all the elements that can be represented in a Deployment Diagram. Graphical representation : There is no special graphical representation of this kind of Diagram. We will still use the informations given in the Annex A of the UML2 Specification document : the diagram will have a frame with a contents area and a heading .

Illustration 1: Deployment Diagram

Use case 3.1.1 : Creation of a Deployment Diagram A Deployment Diagram will necessary be associated with a Package model object. This kind of diagram may be created directly by double clicking on the Package model object. A Diagram will also be created and became the active diagram. Use case 3.1.2 : Deletion of a Deployment Diagram Only the diagram will be deleted. Model objects remains in the model file.

07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 7/13

3.2 Node, Device and ExecutionEnvironment

Model description : A Node is computational resource upon which artifacts may be deployed for execution. Nodes can be interconnected through communication paths to define network structures. It is associated with a Deployment of an Artifact. It is also associated with a set of Elements that are deployed on it. This is a derived association in that these PackageableElements are involved in a Manifestation of an Artifact that is deployed on the Node. The Node is also depicted into two subclasses :

A Device is a physical computational resource with processing capability upon which artifacts may be deployed for execution. An ExecutionEnvironment is a node that offers an execution environment for specific types of components that are deployed on it in the form of executable artifacts.

Graphical representation : A Node is shown as a figure that looks like a 3-dimensional view of a cube.

Illustration 2: Node

A Device is notated by a perspective view of a cube tagged with the keyword device and an ExecutionEnvironment is notated by a Node annotated with the stereotype executionEnvironment.

Illustration 3: Device and ExecutionEnvironment

Use case 3.2.1 : Creation of a Node at the Package level 07/25/2006

Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 8/13

Create the Node model object in the Package container Create the Node model object in the container Node if the content area is big enough to fully show it.

Use case 3.2.2 : Creation of a Node inside another Node

3.3 Artifact
Model description : An artifact is the specification of a physical piece of information that is used or produced by a software development process, or by deployment and operation of a system. Examples of artifacts include model files, source files, scripts, and binary executable files, a table in a database system, a development deliverable, or a wordprocessing document, a mail message. In the metamodel, an Artifact is a Classifier that represents a physical entity. Artifacts may have Properties that represent features of the Artifact, and Operations that can be performed on its instances. Graphical representation : An artifact is presented using an ordinary class rectangle with the key-word artifact. Alternatively, it may be depicted by an icon. Optionally, the underlining of the name of an artifact instance may be omitted, as the context is assumed to be known to users.

Illustration 4: Artifact

Use case 3.3.1 : Create an Artifact at the Package level

Create an Artifact model object in the Package container Create an Artifact model object in the Node container Create a Deployment model object inside the Node and reference the Artifact through the deployedArtifact property of the Deployment model object Create an Artifact model object in the Artifact container

Use case 3.3.2 : Create an Artifact inside a Node

Use case 3.3.3 : Create an Artifact inside another Artifact

07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 9/13

3.4 DeploymentSpecification
Model description : A DeploymentSpecification specifies a set of properties that determine execution parameters of a component artifact that is deployed on a node. A DeploymentSpecification can be aimed at a specific type of container. An artifact that reifies or implements DeploymentSpecification properties is a deployment descriptor. Graphical representation : A DeploymentSpecification is graphically displayed as a classifier rectangle attached to a component artifact deployed on a container using a regular dependency arrow.

Illustration 5: DeploymentSpecification

Use case 3.4.1 : Create a DeploymentSpecification and associate it with a Deployment

Create a DeploymentSpecification model object in the Package container Then select in the Palette the simple link that is used to associate a DeploymentSpecification with a Deployment. Link the DeploymentSpecification node with the Deployment edge in the diagram. This should imply the following model changes :

the DeploymentSpecification is moved into that selected Deployment the deployment property of the DeploymentSpecification is updated.

3.5 Deployment
Model description : A deployment is the allocation of an artifact or artifact instance to a deployment target. A component deployment is the deployment of one or more artifacts or artifact instances to a deployment target, optionally parameterized by a deployment specification. Examples are executables and configuration files. Graphical representation : An alternative notation to containing the deployed artifacts within a deployment target symbol is to use a dependency labeled deploy that is drawn from the artifact to the deployment target. Use case 3.5.1 : Create a Deployment between a DeployedArtifact and and a 07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 10/13

Illustration 6: Deployment

DeploymentTarget

Select first the DeploymentArtifact, and then the DeploymentTarget Update the model :

the Deployment model object should be created into the DeploymentTarget the deployedArtifact property of the Deployment should be updated to reference the DeployedArtifact. move the DeployedArtifact into the DeploymentTarget if necessary ?

3.6 Manifestation
Model description : A manifestation is the concrete physical rendering of one or more model elements by an artifact. In the metamodel, a Manifestation is a subtype of Abstraction. A Manifestation is owned by an Artifact. An artifact embodies or manifests a number of model elements. The artifact owns the manifestations, each representing the utilization of a packageable element. Specific profiles are expected to stereotype the manifestation relationship to indicate particular forms of manifestation. For example, <<tool generated>> and <<custom code>> might be two manifestations for different classes embodied in an artifact. Graphical Representation : A manifestation is notated in the same way as an abstraction dependency, i.e., as a general dashed line with an open arrow-head labeled with the keyword <<manifest>>.

Illustration 7: Manifestation

Use case 3.6.1 : Create a Manifestation between an Artifact and a PackageableElement

Create a Manifestation model object in the source Artifact.

update the utilizedElement property of the Manifestation model object 07/25/2006

Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 11/13

3.7 Dependency
Model description : A dependency is a relationship that signifies that a single or a set of model elements requires other model elements for their specification or implementation. This means that the complete semantics of the depending elements is either semantically or structurally dependent on the definition of the supplier element(s). Graphical representation : A dependency is shown as a dashed arrow between two model elements. The model element at the tail of the arrow (the client) depends on the model element at the arrowhead (the supplier).

Illustration 8: Dependency

Use case 3.7.1 : Create a Dependency between two Artifacts

Create the Dependency model object in the Package container.

update the clients property of the Dependency with the source Artifact update the suppliers property of the Dependency with the target Artifact

3.8 CommunicationPath
Model description : A communication path is an association between two DeploymentTargets, through which they are able to exchange signals and messages. A communication path is an association that can only be defined between deployment targets, to model the exchange of signals and messages between them. Nodes can be connected to represent a network topology by using communication paths. Communication paths can be defined between nodes such as application server and client workstation to define the possible communication paths between nodes. Graphical representation : A CommunicationPath is normally drawn as a solid line connecting two classifiers, or a solid line connecting a single classifier to itself (the two ends are distinct). A Label is drawn at the middle of the connection, the label represent the name of the CommunicationPath model object. 07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 12/13

Illustration 9: CommunicationPath

Use case 3.8.1 : Create a CommunicationPath between two DeploymentTargets

Create the CommunicationPath model object in the Package container Create two Property model objects inside the CommunicationPath (this is a subclass of an Association)

the first Property will reference the source DeploymentTarget through its type property the second Property will reference the target DeploymentTarget through its type property

07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004

TOPCASED

TPC-SPECEDDEPLOYMENT

Page 13/13

4 Conclusion
There is not really a recommendation about the root model object of a such diagram. But regarding to the UML metamodel and the objects that can be created in a Package, it seems that it is the best candidate that should be associated with the Deployment Diagram. Then, there are many ways to represent the Associations between Nodes and Artifacts. In this specification document we choose to use the Deployment and the Dependency links to achieve that. In the future we could see the need to support the nesting of these elements in the diagram. For example, a Node will be the container of its deployed Artifacts. Remarks :

The diagramconfigurator of this diagram should support the configuration of an Edge (SimpleObjectConf) between a Node and an Edge (see the DeploymentSpecification case, when it is associated with a Deployment link).

07/25/2006
Ce document est la proprit d' AIRBUS SAS; il ne peut tre communiqu des tiers and/or reproduit sans son autorisation crite et son contenu ne peut tre divulgu. - AIRBUS SAS - 2004