Skip to main content

Search

Map Components to Solutions

Marco Wülser
  • Updated
This Guide Article has been written for Version 2.1 of the DATAFLOW Software. For Previous Releases use the version selection in the navigation bar at the top of this page.

In this Guide you will learn how to use the Component Mapping feature in the DATAFLOW Software.

 

Introduction

In DATAFLOW Designer V2.1 a new project type was introduced: The Component Project. A Component project has to be created with a new solution. This solution can then be under different version control than other components and than the system architecture project. From the system architecture, a component can be mapped to the component project. Once mapped, all data of this component and any sub components is located in the new project. The system project only contains a reference to the component.

 

Important Terms

Term Definition
System The system element represents the root element of a system architecture. It contains the external interfaces of the system which are propagated to the System Components in system decomposition.
System Context The system context shows all environment influences on the System.
System Component A system component is a sub component in a system architecture on any level. It can be a direct child of the System element or of another system component.
System Project The system project contains the System element and all its child system components as well as the context of the system element. When Components are mapped, it also contains Component References.
System Solution The system solution contains the System Project.
Component

A component is a part of a system architecture that has been moved to its own project. It contains the external interfaces of the component which are propagated to the System Components in the component decomposition.
Component Reference A Component Reference is used to reference a Component in a Component Project from a System Project.
Component Project The Component Project contains the Component element and all its child components as well as the context of the component.
Component Solution The Component Solution contains the Component Project.

 

 

Typical Use Cases

Map Component

To map a component to a separate solution, the following steps have to be performed:

  1. Create a Component Solution with a Component Project
  2. In the System Project, add a reference to the Component Project
  3. Select the System Component to map and perform the Mapping

Mapping a component will move the component and all its child elements from the System Project to the Component Project. Any existing content in the  Component Project will be overwritten by this action.

 

Restore Mapped Component

When the System Solution is checked out and opened, it may happen, that the Component Solution is not available on the computer. The System solution can still be opened and used, except that the mapped component is locked and no changes can be applied. It is also not possible to open the component and see what is inside. To load the component, the referenced component project must be checked out on the same computer. When the referenced Project is reloaded, the location of the Component Solution has to be selected. Once this mapping is restored these steps are not required to be repeated as long as the Component Solution is not renamed or moved to another location.

The path to referenced projects is stored in the *.user file next to the solution file. It is recomended that this file IS NOT checked into version control. This allows every user to map the project to another location.

 

Sync Interface from System to Component

When changes have been made to the component reference interface in the system architecture, they must be propagated to the component project. This can not be done automatically, so a manual action is required:

  1. Check out Component Project
  2. Open System Project and restore Mapping (if required)
  3. Sync changes down from system project to component project
  4. Check in updated component project
  5. Unload Component Project (optional)

 

Sync Interface from Component to System

When changes have been made to the component interface in the component architecture, they must be propagated to the system project. This can not be done automatically, so a manual action is required:

  1. Check out Component Project
  2. Open System Project and restore Mapping (if required)
  3. Sync changes up from component project to system project
  4. Check in updated system project
  5. Unload Component Project (optional)

 

Unmap Component

To remove a mapped component, the following steps have to be performed:

  1. Select the Component Reference to unmap and perform the Mapping
  2. In the System Project, remove the reference to the Component Project
  3. Delete the Component Solution (optional)

Unmapping a component will copy all content from the Component Project to the System project. The component project will not be changed by this action.

 

Required Module: DATAFLOW Designer

This Article has been written based on V2.1.1 of the DATAFLOW software. 
Latest update 2023-06-21 by WUM.

Comments

0 comments

Please sign in to leave a comment.