Getting Started with Innovator for Software Architects

Innovator for Software Architects is the integrated tool for software and IT architecture analyzing and designing software systems using the Unified Modeling Language.

What do you want to do?

Task Help Topic
Define what software should achieve  Formulating Use Cases for the System
Define how software should be structured  Structuring a System with Classes
Define how software should realize a certain behavior  Showing System Behavior as Activity
Define how communication should run within the software  Mapping Flow of Interactions in the System
Describe and comment on model elements  Creating Specification Texts and Comments

Formulating Use Cases for the System

Define what a planned system should achieve

How to proceed

  1. Activate the Start tab in the ribbon.

    This tab contains the New group.

  2. Activate the New Diagram button from the New group.

    The gallery with templates for new diagrams appears.

  3. Select the Use Case Diagram template from the gallery.

    An empty use case diagram is created and opened in the document area. You can now use this diagram to create actors and their use cases.

Tip

You can create various types of diagrams in Innovator models in this way. The types of diagram templates available in the gallery primarily depend on the model template used and the user role selected in a model.

 PAGE START

Work in the use case diagram you just created for the following steps.

How to proceed

  1. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Create Diagram Content group.

  2. Click on the actor icon in the Create Diagram Content group in the gallery.

  3. Move the mouse over the diagram.

    The actor icon is now "attached" to your mouse pointer and follows the movement of the mouse.

  4. With the left mouse button, click again where you want to position the actor.

    The actor is created and is initially given a default name. You can immediately change this.

Alternative procedure:

  1. As above

  2. Click on the actor icon in the Create Diagram Content group in the gallery and keep the left mouse button pressed.

  3. Move the mouse with the left mouse button pressed in the diagram.

    The actor icon is "attached" to your mouse pointer again and follows the movement of the mouse.

  4. Let go of the left mouse button where you want to position the actor.

    The actor is created and is initially given a default name. You can immediately change this.

Tip

You can create various types of diagram elements in Innovator diagrams in this way. The types of elements available in the diagram editor's gallery primarily depend on the diagram type used, the model template used and the user role selected in a model.

 PAGE START

Context

You can create a use case in the same way as an actor (see above).

Alternatively, you can also create a use case by linking it directly with an existing actor. This expresses that this use case is triggered (initiated) by this actor.

How to proceed

  1. Select the actor in the diagram.

    The selected actor has a blue frame around it. There are various semitransparent icons on the right-hand side that are highlighted if you hover the mouse over them – this is called the carousel.

  2. Select the association icon from the carousel and keep the left mouse button pressed.

  3. With the left mouse button pressed, drag the icon to a free point in the diagram.

    The position of the association that will be created is shown when you drag the icon by a blue rubber band line.

  4. Release the left mouse button on a free point in the diagram.

    A drop-down list with the partner elements permissible for this type of relationship appears. A  use case is offered as the only element in the list in this case.

  5. Left mouse click on this entry.

    The use case and association to the actor are created; the use case is initially given a default name. You can immediately change this.

Tip

You can create various kinds of different connection types in Innovator diagrams in this way. The types of elements available in a diagram element's carousel and in the drop-down list primarily depend on the diagram type used, the model template used and the user role selected in a model.

 PAGE START

Structuring a System with Classes

Define how a planned system should be structured

How to proceed

  1. Activate the Start tab in the ribbon.

    This tab contains the New group.

  2. Activate the New Diagram button from the New group.

    The gallery with templates for new diagrams appears.

  3. Select the Class Diagram template from the gallery.

    An empty class diagram is created and opened in the document area. You can now use this diagram to create classes, interfaces or other classifiers.

Tip

You can create various types of diagrams in Innovator models in this way. The types of diagram templates available in the gallery primarily depend on the model template used and the user role selected in a model.

 PAGE START

Work in the class diagram you just created for the following steps.

How to proceed

  1. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Create Diagram Content group.

  2. Select the Class icon from the gallery.

  3. Move the mouse over the diagram.

    The class icon is now "attached" to your mouse pointer and follows the movement of the mouse.

  4. Click where you want the class to go with the left mouse button pressed.

    The class is created and is initially given a default name. You can immediately change this.

The alternative way of creating an actor (see above) is also possible in this step.

Tip

You can create various types of diagram elements in Innovator diagrams in this way. The types of elements available in the diagram editor's gallery primarily depend on the diagram type used, the model template used and the user role selected in a model.

 PAGE START

Context

You can create attributes using the class' context menu or the ribbon.

How to proceed

Using the context menu:

  1. Right-click on the class you want to create the attribute for.

    The selected class has a blue frame around it. The context menu for classes in the class diagram appears. The mini toolbar can be found above the context menu:

    The colored bar at the top contains icons for commands for creating elements that can be content for the selected class, e.g. Attribute, Operation or (inner) Class.

  2. Click on the Attribute icon.

    The attribute is created within the class and is added to the class' «Attribute» section's content. It is initially given a default name that you can immediately change.

Another way to proceed using the ribbon:

  1. Select the class in the diagram with the left mouse button.

    The selected class has a blue frame around it.

  2. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Create Diagram Content group.

  3. Open the  Properties submenu in this group.

    The submenu contains icons for commands for creating elements that can be content for the selected class, e.g. Attribute or Operation.

  4. Click on the Attribute icon.

    The attribute is created within the class and is added to the class' «Attribute» section's content. It is initially given a default name that you can immediately change.

Tip

If you have already created an attribute in a class, then you can create further attributes quickly by selecting the existing attribute and pressing the [Ctrl]+[+] shortcut keys.

 PAGE START

Prerequisites

As described above for attributes, you have created an operation in your class.

Context

The name is not the only deciding factor for an operation, the amount and type of input and output parameters also play a role. You can find out how to edit the entire declaration of an operation here.

How to proceed

  1. Select the operation in the class with the left mouse button.

    The selected operation has a blue frame around it.

  2. In the context menu of the operation, select the command Edit Declaration or use the shortcut [Ctrl]+[F2].

    The dialog for editing the declaration opens. The multi-row editing field initially contains the name of the operation and an empty parameter list, e.g. "Operation()".

  3. In the parentheses, enter the name of the first parameter and then a colon.

    The input help opens and shows all known classifiers in the model in alphabetical order as this parameter's type:

    Entering the first few letters shortens the input help to the types that still match step-for-step.

  4. Select the type you are searching for in the input help list.

    The parameter's type is adopted in the editing field after the colon.

  5. (Optional) Enter a comma and repeat steps 3 and 4 to define more parameters and their type.

  6. (Optional) Before the parameter name, enter the key word out or inout to define an output or input/output parameter.

  7. (Optional) Enter a colon after the closing parenthesis and repeat step 4 to define the operation's return type.

  8. Click on or use the shortcut [Ctrl]+[Enter] in the edit field to apply the declaration.

 PAGE START

Prerequisites

This example assumes that both classes to be linked are already in the diagram. Alternatively, you can create a new class together with the association, as you did when creating use cases (see above).

How to proceed

  1. Select the class in the diagram

    The selected class has a blue frame around it. There are various semitransparent icons on the right-hand side that are highlighted if you hover the mouse over them – this is called the carousel.

  2. Select the association icon from the carousel and keep the left mouse button pressed.

  3. With the left mouse button pressed, drag the icon in the direction of the class to be connected.

    The position of the association that will be created is shown when you drag the icon by a blue rubber band line.

  4. Let go of the mouse on the class you want to create the association to.

    The association is created and initially contains the properties preallocated in the Association template. You can immediately change these properties using the  Properties tool window or the association's context menu.

Tip

There are predefined templates for many regularly used association types, such as "1:many" or "Aggregation", in which properties such as "Upper and Lower Bound", "Navigability" or "Kind of Aggregation" are already preallocated. You can save yourself the hassle of making changes at a later stage by selecting the suitable template.

 PAGE START

Context

Directed relationships are created in the same way as associations (see above); the only difference is that you always have to work from the dependent element to the independent element.

How to proceed

  1. Select the class you want to create an inheritance relationship for with the left mouse button.

    The selected class has a blue frame around it. The carousel appears on the right-hand side, as was the case in the previous step.

  2. Select the generalization icon from the carousel and keep the left mouse button pressed.

  3. With the left mouse button pressed, drag the icon in the direction of the class to be connected.

    The position of the inheritance relationship that will be created is shown when you drag the icon by a blue rubber band line.

  4. Let go of the mouse on the class your class should inherit from.

    The inheritance relationship is created and displayed in the diagram.

Dependency relationships are created in the same way as generalizations, by using one of the arrow icons (, , etc.) in the carousel. You can find out how the dependency relationships differ from each other in the tool tip for the respective arrow icon.

Tip

If you have created a directed relationship in the wrong direction by mistake then you can fix this by right-clicking on the incorrect relationship and running the  Revert Direction command in the relationship's context menu.

 PAGE START

Showing System Behavior as Activity

Define how the system should realize a planned behavior

Prerequisites

You need to set which class, component or use case a behavior should be specified from before you can create an activity diagram.

How to proceed

  1. (Optional) Select a BehavioredClassifier (class, component, or similar).

  2. Activate the Start tab in the ribbon.

    This tab contains the New group.

  3. Activate the New Diagram button from the New group.

    The gallery with templates for new diagrams appears.

  4. Select the Activity template from the gallery.

  5. If you omitted step 1, a selection dialog prompts you to select a suitable BehavioredClassifier. Select an existing BehavioredClassifer or use the Create New Element button to create a required BehavioredClassifer that does not yet exist. In this case, a wizard guides you through the necessary steps.

If you selected a classifier in step 1 or 5, then a new activity diagram is created and opened in the document area; it initially only contains the activity itself but no details about this activity. You can now use this diagram for displaying individual actions of this activity.

 PAGE START

Work in the activity diagram you just created for the following steps.

Context

Actions are the smallest executable element within an activity. This document initially only uses actions of the "Generic Action" type; what should happen to the action is described as text.

How to proceed

  1. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Create Diagram Content group.

  2. Select the Execute Instruction icon from the gallery.

  3. Move the mouse in the diagram within the activity's frame.

    The action icon is "attached" to your mouse pointer and follows the movement of the mouse. If the mouse pointer is outside of this frame it then changes to an icon to show that you cannot create an action outside of the activity.

  4. Click the left mouse button where you want to position the action.

    The action is created and is initially shows a default expression. You can immediately change this.

 PAGE START

Context

The order of actions is based on the control flow that links the actions with each other.

How to proceed

If the subsequent action already exists in the diagram:

  1. Select an action in the diagram.

    The selected action has a blue frame around it. There are various semitransparent icons on the right-hand side that are highlighted if you hover the mouse over them – this is called the carousel.

  2. Select the control flow edge icon from the carousel and keep the left mouse button pressed.

  3. With the left mouse button pressed, drag the icon in the direction of the action to be connected.

    The position of the control flow edge that will be created is shown when you drag the icon by a blue rubber band line.

  4. Let go of the mouse on the action you want to connect using the control flow edge.

    The control flow edge is created. As with almost all model elements, it has a logical name; however, this is not relevant for the modeling and is not visible in the diagram. You can immediately change the properties of the control flow edge using the  Properties tool window or the edge's context menu.

Another way to proceed if the subsequent action does not exist in the diagram yet:

  1. Select an action in the diagram.

    The selected action has a blue frame around it. There are various semitransparent icons on the right-hand side that are highlighted if you hover the mouse over them – this is called the carousel.

  2. Select the control flow edge icon from the carousel and keep the left mouse button pressed.

  3. With the left mouse button pressed, drag the icon to a free point in the diagram.

    The position of the control flow edge that will be created is shown when you drag the icon by a blue rubber band line.

  4. Release the left mouse button on a free point in the diagram.

    A drop-down list with the permissible successors for the selected action appears. The list contains various actions and "Pseudo Nodes" (fork, split etc.).

  5. Click with the left mouse button on the entry you want (e.g. on  Execute statement).

    The action and the control flow edge to this action are created; the action initially has a default text. You can immediately change this.

 PAGE START

To show the data object in the diagram

How to proceed

  1. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Create Diagram Content group.

  2. Select the Data Store Node icon from the gallery to show that data should be stored persistently, or select the Central Buffer Node icon to show that the data should only be temporarily buffered during execution of the activity.

  3. Move the mouse in the diagram within the activity's frame.

    The data store or buffer icon is "attached" to your mouse pointer and follows the movement of the mouse. If the mouse pointer is outside of this frame it then changes to an icon to show that you cannot create a data store/buffer outside of the activity.

  4. Click the left mouse button where you want to position the node.

    The data store/buffer node is created. As the data type has not been specified yet, the node initially only shows the key word «datastore» or «centralBuffer». You can change the data type directly using the  Properties tool window or with the Assign Type command in the data store/buffer node's context menu.

Create an object flow from the direction of the writing action to express that a action writes data:

  1. Select the writing action in the diagram.

    The selected action has a blue frame around it. There are various semitransparent icons on the right-hand side that are highlighted if you hover the mouse over them – this is called the carousel.

  2. Select the Object Flow Edge icon from the carousel and keep the left mouse button pressed.

  3. With the left mouse button pressed, drag the icon in the direction of the data store/buffer node to be connected.

    The position of the object flow edge that will be created is shown when you drag the icon by a blue rubber band line.

  4. Release the mouse button over the node that the object flow edge should flow into.

    The object flow edge is created. As with almost all model elements, it has a logical name; however, this is not relevant for the modeling and is not visible in the diagram. You can immediately change the properties of the control flow edge using the  Properties tool window or the edge's context menu. An output pin of the same type as the linked data store/buffer node automatically appears for the writing action.

Create an object flow in the direction of the writing action to express that a action reads data:

  1. Select the data store/buffer node in the diagram.

    The selected node has a blue frame around it. There is a semitransparent icon on the right-hand side; if you hover over it with the mouse it is highlighted – this is called the carousel.

  2. Select the Object Flow Edge icon from the carousel and keep the left mouse button pressed.

  3. With the left mouse button pressed, drag the icon in the direction of the reading action.

    The position of the object flow edge that will be created is shown when you drag the icon by a blue rubber band line.

  4. Release the mouse button over the action that the object flow edge should flow into.

    The object flow edge is created. As with almost all model elements, it has a logical name; however, this is not relevant for the modeling and is not visible in the diagram. You can immediately change the properties of the control flow edge using the  Properties tool window or the edge's context menu. An input pin of the same type as the linked data store/buffer node automatically appears for the reading action.

Tip

You can also create both the object flow edge and data store/buffer node diagram elements at the same time by starting the object flow at the action the data will be written from using the "carousel" and releasing the left mouse button on a free point in the diagram.

 PAGE START

Prerequisites

(Optional) You have already defined an operation that should be called within your modeled activity within the framework of the "Structuring a System with Classes" topic.

Context

A special action type, a CallBehaviorAction, is used for calling an operation in UML activity diagrams.

How to proceed

  1. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Create Diagram Content group.

  2. Select the Call Operation icon from the gallery.

  3. Move the mouse in the diagram within the activity's frame.

    As above, the action icon is "attached" to your mouse pointer and follows the movement of the mouse.

  4. Click the left mouse button where you want to position the operation call.

    The Prerequisite dialog is opened and contains the operations already defined in your model.

  5. Select an existing operation or use the Create New Element button to create a missing operation. In this case, a wizard guides you through the necessary steps.

  6. Confirm your selection by clicking on the OK button.

    The call action is created and labeled with the name of the called operation. A respective input or output pin is automatically created at the call action for each of the operation's parameters.

Another way to proceed by converting an existing action into an operation call:

  1. Select the action you want to convert into a call action with the left mouse button.

    The selected action has a blue frame around it.

  2. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Model Elements group.

  3. Open the Refactor submenu in this group and click on the  Change Element Type command there.

    The wizard for converting model elements is opened.

  4. Select the  (call operation) entry in step 1. Click on the Next button to go to step 2.

    You can set that the action should be converted into an operation in this way. The Prerequisite dialog is then opened; it contains operations that are already defined in your model.

  5. Select an existing operation or use the Create New Element button to create a missing operation in step 2. Another wizard then takes you through the steps necessary for this.

  6. Confirm your selection by clicking on the OK button.

    The wizard for converting model elements is ready for conversion and gives a brief summary of the effects expected by the conversion.

  7. Start the conversion by clicking on Finish.

    The action is converted into a call action and labeled with the name of the called operation. A respective input or output pin is automatically created at the call action for each of the operation's parameters.

 PAGE START

Mapping Flow of Interactions in the System

Define how communication should run within the system

Prerequisites

In order to be able to create a sequence diagram, you must define the BehavioredClassfier (this is usually a class or component) that should describe an interaction.

How to proceed

  1. (Optional) Select a BehavioredClassifier (class, component, or similar).

  2. Activate the Start tab in the ribbon.

    This tab contains the New group.

  3. Activate the New Diagram button from the New group.

    The gallery with templates for new diagrams appears.

  4. Select the interaction template from the gallery.

  5. If you omitted step 1, a selection dialog prompts you to select a suitable BehavioredClassifier. Select an existing BehavioredClassifer or use the Create New Element button to create a required BehavioredClassifer that does not yet exist. In this case, a wizard guides you through the necessary steps.

If you selected a classifier in step 1 or 5, then a new sequence diagram is created and opened in the document area; it initially only contains the interaction itself but no details about this interaction. You can now use this diagram for creating communication partners as lifelines and displaying communication between these partners.

 PAGE START

Work in the sequence diagram you just created for the following steps.

Prerequisites

The BehavioredClassifier which the interaction belongs to needs to be able to be structured by "connectable elements (ConnectableElements)" to be able to define participants for an interaction in a way that makes sense. As actors and use cases classify as BehavioredClassifiers but cannot be structured, only lifelines for the actor or use case as a whole can be created to both these element types in interactions.

Context

Communication partners involved in an interaction are represented in UML sequence diagrams by so-called "lifelines"; they show the chronological sequence of the sent and received messages.

How to proceed

  1. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Create Diagram Content group.

  2. Select the lifeline icon from the gallery.

  3. Move the mouse in the diagram within the interaction's frame.

    The lifeline icon is "attached" to your mouse pointer and follows the movement of the mouse. If the mouse pointer is outside of this frame it then changes to an icon to show that you cannot create a lifeline outside of the interaction.

  4. Click the left mouse button where you want to position the first lifeline.

    The Prerequisite dialog is opened and is initially empty as no interaction partner has been selected.

  5. Click on Add....

    The Add Prerequisite dialog is opened and contains the interaction's BehavioredClassifier and its ConnectableElements as they are already defined in your model. Select the BehavioredClassifier or one of its ConnectableElements, or use the Create New Element button to create a missing ConnectableElement. In this case, a wizard guides you through the necessary steps.

  6. Confirm your selection by clicking on the OK button.

    The selected elements are inserted into the sequence diagram as lifelines next to each other and either labeled with the type of the selected ConnectableElement or with the key word "self". If the latter is the case, the lifeline represents the BehavioredClassifier of the interaction as a whole. You can change the properties of a lifeline directly using the  Properties tool window.

 PAGE START

Context

A so-called signal that contains information to be sent is sent from the sender to the recipient to express that a message is sent in UML sequence diagrams.

How to proceed

  1. Left-click to select the vertical (dashed) part of the lifeline from which the message should be sent.

    The selected lifeline is shown with a blue selection frame. There are various semitransparent icons on the right-hand side that are highlighted if you hover the mouse over them – this is called the carousel.

  2. Select the From Signal... icon from the carousel and keep the left mouse button pressed.

  3. With the left mouse button pressed, drag the icon in the direction of the lifeline the message should be sent to.

    The position of the message edge that will be created is shown when you drag the icon by a blue rubber band line. If the mouse pointer is not over a lifeline then it changes to an icon to show that you cannot create a message at this point.

  4. Let go of the left mouse button over the lifeline you want to send the message to.

    The Prerequisite dialog opens and includes the signals already defined in your model.

  5. Select an existing signal or use the Create New Element button to create a signal which has not been defined yet. In this case, a wizard guides you through the necessary steps.

  6. Confirm your selection by clicking on the OK button.

    The message edge is created and labeled with the name of the signal sent.

 PAGE START

Prerequisites

(Optional) You have already defined an operation that should be called within your modeled interaction within the framework of the "Structuring a System with Classes" topic.

Context

A special message type, a so-called (synchronous or asynchronous) OperationCall is used to call an operation in UML sequence diagrams.

How to proceed

  1. Select the vertical (dashed) part of the lifeline which the operation should be called from with the left mouse button.

    The selected action has a blue frame around it. There are various semitransparent icons on the right-hand side that are highlighted if you hover the mouse over them – this is called the carousel.

  2. Select one of the Synchronous Call icons from the carousel or Asynchronous Call and keep the left mouse button pressed.

  3. With the left mouse button pressed, drag the icon toward the lifeline at which an operation is to be called.

    The position of the message edge that will be created is shown when you drag the icon by a blue rubber band line. If the mouse pointer is not on a lifeline then it changes to an icon to show that you cannot create an operation call at this point.

  4. Let go of the left mouse button over the lifeline you want to send the operation call to.

    The Prerequisite dialog is opened and contains the operations already defined in your model.

  5. Select an existing operation or use the Create New Element button to create a missing operation. In this case, a wizard guides you through the necessary steps.

  6. Confirm your selection by clicking on the OK button.

    The operation call is created and labeled with the name of the called operation, including the name of all parameters of this operation.

 PAGE START

Creating Specification Texts and Comments

Describe and comment on model elements

Context

Lots of model elements can have a textual specification to describe a certain aspect of a model element in more detail. Specification texts are primarily used for documenting the model and its model elements.

How to proceed

  1. (Optional) Select one or more model elements in the diagram that you want to edit their specification with the left mouse button.

    If you have not selected a diagram element, Innovator assumes that the diagram itself should be given a specification.

  2. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Edit group, which contains the Specification (F3) icon. If this icon is inactive, then you have selected an element that textual specifications cannot be created for.

  3. Click on the Specification (F3) icon.

    A new window opens for each selected element in the right-hand half of the document area; it shows all available specification texts for this element.

  4. Enter the text in the respective text definition.

    The name of the text definition to be edited is shown in red if your changes have been made.

  5. Format the text using the Text tab or the context menu.

  6. Close the text with Text>Specification>Save (Ctrl+S).

    The name of the edited text definition is shown in black again if the save was successful.

  7. Close the window with the specification texts once you have finished editing.

 PAGE START

Context

You can add comments to diagrams to e.g. help other users better understand a diagram.

How to proceed

  1. (Optional) Select one or more diagram elements that you want to comment on with [Ctrl] and the left mouse button.

  2. Activate the Design tab in the ribbon if this is not the active tab.

    This tab contains the Create Diagram Content group.

  3. Click on the Comment icon.

    If you selected parts of the diagram in part 1, a comment is created for all selected diagram elements. It initially contains a default text, is positioned in the middle and linked with all selected diagram elements by a dotted line. The comment is placed left above this element if only one diagram element was selected.

  4. If you missed out step 1, move the mouse in the direction of the element you want to comment on.

    The comment icon is "attached" to your mouse pointer and follows the movement of the mouse.

  5. Click with the left mouse button on the diagram element you want to comment on.

    The comment is created for the diagram element you clicked on. It initially contains a default text, is positioned top-left above this element and is linked with this by a dotted line.

  6. Overwrite the default comment text directly with your own comment. Use the [Enter] key for hard returns.

  7. To finish the comment, click on [Ctrl]+[Enter] or [(Nicht definierte Variable:UIVar_Menu.KeyTab)].

Another way to proceed using the context menu:

  1. Select one or more diagram elements that you want to make a comment for and press the right mouse button to open the context menu for this selection.

  2. Click on  New Comment.

    A comment is created for all selected diagram elements. It initially contains a default text, is positioned in the middle and linked with all selected diagram elements by a dotted line. The comment is placed left above this element if only one diagram element was selected.

  3. Overwrite the default comment text directly with your own comment. Use the [Enter] key for hard returns.

  4. To finish the comment, click on [Ctrl]+[Enter] or [(Nicht definierte Variable:UIVar_Menu.KeyTab)].

 PAGE START