Cameo Datahub 2024x Refresh1

User Guide

No Magic, Inc., a Dassault Systèmes company, 2024

All material contained herein is considered proprietary information owned by No Magic, Inc. and is not
to be shared, copied, or reproduced by any means. All information copyright 1998-2024 by No Magic,
Incorporated, a Dassault Systèmes company. All Rights Reserved.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company.

Contents

Cameo DataHub can help you solve data interoperability

issues between different vendors. 7
This easy to use tool allows customers to: 7
Business Benefits Overview 8
Introduction to Cameo DataHub 8
Installation, licensing, and system requirements 8
Getting started 9
Understanding DataHub user interface 9
DataHub menu 9
DataHub Explorer tab 17
DataHub Properties tab 24
DH Links panel 26
DataHub alias 30
Compatible data sources 31
Schema map and mapping options 31
Driver deployment 40
OSLC support 41
Add-on features 41
Opening DataHub Explorer 43
DataHub basic operations 44
Displaying MagicDraw Data Sources in DataHub Explorer 45
Customizing module and object label in DataHub Explorer 48
Basic features of DataHub 50
DataHub Operation drop-down list 51
Mapping source and target types to copy data to and from a modelling
tool 52
Creating OSLC Query operation 54
Data Synchronization 54

User Guide 55

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 3

Contents
Working with DataHub and modeling tools 55
Customizing DataHub options 56
Working with the DataHub Explorer tree 69
Operations in DataHub Explorer 77
Working with Data Sources 118
Working with OSLC features 171
Creating links between elements 194
Requirement Mapping 202
Working with the DHLink summary and generating reports 213
Using DataHub in Teamwork Cloud environment 223
Data Sources on Teamwork Cloud 223
Synchronization 226
How synchronization works 227
Synchronizing Requirements 227
One-way synchronization 243
Synchronize buttons and commands 246
Defining a target type from an attribute value 251
Synchronizing changes in data hierarchy 255
Excluding some nodes when copying data 255
Checking for node changes before synchronizing data 257
Synchronizing nodes 259
Synchronizing changes in schema mapping 259
Splitting part of a synchronized model as a used project 261
Copying data with custom types and properties 264
Schema Mapping 264
Mapping modes 264
Working with Schema Map Manager 266
UI components of Schema Map Manager 267
Exporting a schema map as a new template 268
Additional DataHub features 275
HTML images, RTF, and OLE support 276

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 4

Contents
Working with custom IP Classification attributes 281

Glossary 285
Alias 286
Artifact 286
Bidirectional 286
Data 286
DataHub operations 286
DataHub tree 287
Data Source 287
DHTrace 287
Driver 288
Excluded 288
Global ID 288
HP Application Lifecycle Management (HP ALM) 288
Item 288
Item type 288
Link 289
Mapping mode 289
Module 289
Node 289
Orphan 289
OSLC 289
OSLC link 290
OSLC query 290
PendingDelete 290
PendingUpdate 290
Recursively 290
Relationship 290

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 5

Contents
Requirements traceability 290
Schema map 291
Status 291
Synchronized 291
Sync relation 291
System model 292
Unidirectional 292
Troubleshooting 292
Server Certificate tool 292

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 6

Cameo DataHub is a powerful data bridge solution that enables the import/export, automatic
synchronization and creation of references between MagicDraw®, SysML Plugin, UPDM Plugin,
Rational® DOORS® , Enovia™ TRM, and CSV files. Support for other tools/formats/repositories to be
forthcoming.

Cameo DataHub is an important part of your development process that enhances traceability between
your requirements gathering/analysis to your design/development. Cameo DataHub enables both
stakeholders and developers to communicate effectively via their own preferred tools. For example, a
business user may use Enovia TRM or Rational® DOORS® to create requirements that may be linked
and continually synchronized to models in MagicDraw®. Conversely, developers may link designs back
to specific requirements, preventing ambiguity and identifying implementation oversights.

Cameo DataHub can help you solve data

interoperability issues between different vendors.
This easy to use tool allows customers to:
• Unify and relate requirements to the system architecture and design
• Handle the relationship/dependency and information when change occur
• Transform data from requirements-to-model or model-to-requirements
• Associate and synchronize data (both automatic and manual)
• Monitor data when associated data changes

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 7

Business Benefits Overview
• Lowers the business risks to near zero for both current and future projects by ensuring your
data will always be accessible
• Easier understanding and editing of artifact dependencies via a visual schema mapper
• Automatic monitoring of ongoing changes that may affect artifacts from either requirements
or design
• Associates and synchronizes tool data - may initiate synchronization either manually or
automatically as configured on a per-tool basis
• Reduces the cost of maintaining consistency
• Data synchronization for multiple vendor requirements management tools without requiring
their being resident in memory or even running on the same platform

To learn how to install and use Cameo DataHub, see:

• Introduction to Cameo DataHub (see page 8)

• Installation, licensing, and system requirements (see page 8)
• Getting started (see page 9)
• User Guide (see page 55)
• Glossary (see page 285)
• Troubleshooting (see page 292)

Documentation of earlier versions:

• Cameo DataHub 2021x Refresh21

• Cameo DataHub 2021x Refresh12
• Cameo DataHub 2021x3
• Cameo DataHub 19.0 SP44
• Cameo DataHub 19.0 SP35
• Cameo DataHub 19.0 SP26
• Cameo DataHub 19.0 SP17
• Cameo DataHub 19.08

Introduction to Cameo DataHub

Installation, licensing, and system requirements
For information regarding installation, licensing, and system requirements, visit the Installation,
licensing, and system requirements9 page.

1 https://docs.nomagic.com/display/CDH2021xR2/Cameo+DataHub+Documentation
2 https://docs.nomagic.com/display/CDH2021xR1/Cameo+DataHub+Documentation
3 https://docs.nomagic.com/display/CDH2021x/Cameo+DataHub+Documentation
4 https://docs.nomagic.com/display/CDH190SP4/Cameo+DataHub+Documentation
5 https://docs.nomagic.com/display/CDH190SP3/Cameo+DataHub+Documentation
6 https://docs.nomagic.com/display/CDH190SP2/Cameo+DataHub+Documentation
7 https://docs.nomagic.com/display/CDH190SP1/Cameo+DataHub+Documentation
8 https://docs.nomagic.com/display/CDH190/Cameo+DataHub+Documentation
9 https://docs.nomagic.com/display/IL2024xR1/Installation%2C+licensing%2C+and+system+requirements

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 8

Getting started
This user guide is intended to serve as an introduction to the Cameo DataHub features and
functionality and how to use it to work with requirement management tools such as
IBM® Rational® DOORS® and IBM® Rational® DOORS® Next Generation. This user guide also contains
examples of how to use the DataHub features of copying data, linking, and synchronization. You will be
able to copy requirements, link them to one another, as well as link them to system design models such
as Use Cases, artifacts, and test cases. Additionally, the DataHub also supports working with
requirements in a collaborative context by providing data sharing among team members via Teamwork
Cloud (see page 9).

This user guide is an introduction to the UI components of DataHub and some of its features. The last
section of this user guide provides the definitions of the terms used in the DataHub context. The
features of the plug-in that are explained in this user guide includes: User Interface, copy features, OSLC
link and query, and DataHub configuration elements.

Understanding DataHub user interface

This chapter is an introduction to the various elements of the DataHub User Interface, menus, dialogs,
context menus, tabs and panels.

Cameo DataHub allows you to work with requirement management tools such as
IBM® Rational® DOORS®, IBM® Rational® DOORS® Next Generation, and MagicDraw®. The DataHub
also allows you to copy and synchronize Requirements. DHLink links Requirements to one another and
also links Requirements to system design models and test cases.

DataHub provides unidirectional or bidirectional synchronization capabilities between target and

source nodes. A synchronization Conflict Dashboard shows the sync status and options for additional
synchronization.

Before using DataHub to connect with IBM® Rational® DOORS®, you must first deploy the DOORS
driver (see page 40).

DataHub menu
To access the DataHub menu, you need to start MagicDraw® and open a new or existing project.

To open the DataHub menu in MagicDraw®

• From the MagicDraw main menu, click Tools > DataHub. The DataHub menu items open.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 9

 DataHub menu items.
The table below explains the functions of the DataHub menu items.

Name Function

Synchronize updates to Synchronizes the node if there are any pending changes. Otherwise, does nothing.
Data Source

DataHub Explorer Opens the DataHub Explorer tab.

DHLink Panel Opens the DHLink Panel

DHLink Summary Opens the DHLink Summary dialog

Schema Map Manager Opens the Schema Map Manager dialog

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 10

 Name Function

Alias Manager Opens the Alias Manager dialog

Remove non-use Opens the Remove DHLinks Confirmation dialog to remove DHLinks that are not in
DHLink the project.

Migrate DataHub Opens the Cameo DataHub Migration dialog. Data from older versions of DataHub
are migrated to the latest version of DataHub.

Driver Deployment Opens the Driver Deployment dialog

Create OSLC Query Opens the OSLC Query Editor dialog

Actions Opens the Actions menu

3rd Party Libraries Info Opens the 3rd Party Libraries Info dialog.

 Note
Some of the DataHub menu items may be disabled if those items are not applicable in the
current context. For example, the Create OSLC query menu item is enabled only when you
have an IBM® Rational® DOORS® Next Generation Data Source open.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 11

 DataHub Actions menu items.
The table below explains the functions of the DataHub Actions menu items.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 12

 Name Function

Add Data Source Opens the Add Data Source dialog.

Connect Connects to the selected Data Source.

Close Data Source Closes a Data Source.

Save Saves changes to a Data Source.

Remove Data Removes a Data Source from the DataHub Explorer instances.
Source

New Node Adds a new node under the selected node or Data Source.

Delete Node Removes the selected node.

Reload Reloads all properties and items on the selected item and sub-items.

Select in Selects the selected node in its original application.

Application

Go to the Other Goes to a related linked item (within DataHub Explorer).

Related Link

Check Changes Reviews all nodes that have been changed or edited without synchronizing them.
The Check Changes menu has four sub-menus

• Check DHLink Changes:

Views the changes in DHLinks only in the selected node.
• Check DHLink Changes Recursively:
Views the changes in DHLinks in both the selected node and its children.
• Check DHTrace Changes:
Determines trace changes in the selected node.
• Check DHTrace Changes Recursively:
Determines changes in trace links in the selected node and its children.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 13

 Name Function

Synchronize Sends data updates from the selected Data Source to all of the related items in other
tools. This option performs data synchronization for DHLinks only, but DHTraces are not
synchronized. The Synchronize menu contains two sub-menus

• Synchronize Node:
Synchronizes data only in the selected node.
• Synchronize Node Recursively:
Synchronizes data under the selected node and all its child nodes.

Update DHLinks Updates pending updates and pending delete DHLinks. This menu item has four sub-
menu items

• Update Pending DHLinks:

Updates pending DHLinks in a single node.
• Update Pending DHLinks Recursively:
Updates pending DHLinks across a node and its children.
• Clear Suspect DHTraces:
Clears suspect DHLinks in a single node.
• Clear Suspect DHTraces Recursively:
Clears suspect DHLinks across a node and its children.

Remove DHLinks Removes all the DHLink information from the selected node. This menu item has four
sub-menu items

• Remove DHLinks:
Removes all DHLinks from a single node.
• Remove DHLinks Recursively:
Removes all DHLinks from a node as well as all its children.
• Remove DHTrace:
Removes all DHTrace links from a node.
• Remove DHTrace Recursively:
Removes all DHTrace links from a node and all its children.

Create Alias Creates an alias for the selected node and adds it to Alias Manager.

Properties Opens the Cameo DataHub Properties tab and DH Links panel for the selected node.

 Important
Removing a Data Source deletes all of its mappings and DHLinks.

Related page

• Hot keys (see page 15)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 14

Hot keys
The DataHub hotkeys are available in MagicDraw®. You can define a set of hotkeys to execute
particular DataHub commands as follows

• Add Data Source

• Check Node Changes Recursively
• Check Node Changes
• Clean up DataHub Database
• Connect
• Create Alias
• Create OSLC Query
• DHLink Panel
• DHLink Summary
• DataHub Explorer
• Alias Manager
• Go To The Other Related Node
• New Node
• Prepare Data for Module
• Remove DHLink Recursively
• Remove DHLink
• Remove DataSource
• Schema Map Manager
• Synchronize Node Recursively
• Synchronize Node
• Synchronize
• Update Pending DHLink Recursively
• Update Pending DHLink

To assign a hotkey to any of the available DataHub functions

1. From the MagicDraw main menu, click Options > Environment. The Environment Options
dialog opens.
2. On the left-hand side, select Keyboard. From the expandable list, select DataHub.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 15

 3. From the expandable list, select the function you want to create a hotkey for.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 16

 4. In the Press new shortcut key box, click in the box and press any key or key combination
(holding one or two keys while pressing another key) you want to designate.
5. Click Assign.

 Tip
If the key or key combination you have pressed has already been assigned to another function,
it will display "Currently assigned to: <assigned function>" below the Press new shortcut key
box. In this case, choose another key combination.

DataHub Explorer tab

The DataHub Explorer tab has toolbar options for the following actions

• Add a new Data Source

• Close a Data Source
• Open a Data Source
• Filter inactive Data Source
• Create OSLC query
• Work with data in the tree
• Search for items

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 17

You can use DataHub Explorer toolbar buttons and shortcut menu items to connect, add, or remove
Data Sources. You can also use it to view drivers, Data Sources, and items of the connected Data
Sources in the DataHub tree. You can also apply a filter to display only the connected Data Sources in
DataHub Explorer.

To open DataHub Explorer

1. Start MagicDraw® and open an existing project or start a new one.

2. From the MagicDraw main menu, click Tools > DataHub > DataHub Explorer. The DataHub
Explorer tab opens.

The DataHub Explorer tab contains the following

• Operation drop-down list

• Tree of Data Sources
• Explorer buttons and icons
• Text search box
Related pages

• Operation drop-down list (see page 18)

• DataHub tree (see page 21)
• DataHub Explorer buttons and icons (see page 22)

Operation drop-down list

On this page

• Copy Data (see page 19)

• Copy Data with Sync (see page 19)
• Copy Data with DHTrace (see page 19)
• Create Sync (see page 20)
• Create DHTrace (with OSLC links) (see page 20)
• Creating OSLC links (through the Create DHTrace operation) (see page 20)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 18

The DataHub Operation drop-down list has multiple operations as described below.

The DataHub Operation drop-down list.

Copy Data
This operation only copies data. It does not allow synchronization.

Copy Data with Sync

This operation mode allows copying data with synchronization. You can perform synchronization
between source and target nodes, either unidirectional or bidirectional, in this mode.

Copy Data with DHTrace

This operation mode copies data and also includes a trace link between the source and target
elements. When a node containing a trace link changes, that trace link is marked Suspect.

Trace links or DHTrace links can exist between text-based Requirements and models or elements that
define them, like use cases, system artifacts, documents, and other Requirement objects.

When the nodes being traced are modified, deleted, or moved, you can right-click a node in either the
MagicDraw Containment tree or DataHub Explorer and select Check DHTrace Changes Recursively.
Choosing this option opens up the DHTrace Summary dialog which lists all the Suspect links in the
system. You can choose to clear the Suspect trace through the DHTrace Summary dialog or you can
leave them. In this case, the Requirement is validated.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 19

Create Sync
This operation recreates synchronization (DHLinks) in case you lose or delete the DHLinks. The
synchronization (DHLinks) is recreated without replicating the data.

Create DHTrace (with OSLC links)

This operation mode creates a DHTrace link between the source and target items. A trace link can exist
between two requirement objects or between requirements and their model elements such as a use-
case. As in the previous operation mode, whenever the source or target nodes are moved, modified, or
deleted, will result in the trace link becoming Suspect.

You can then right-click the node in the MagicDraw containment tree or DataHub Explorer and choose
Check DHTrace Changes Recursively. The DHTrace Summary dialog will open allowing you to clear
the trace links which have acquired a suspect status, thus validating the state of the requirement and
the linked UML element.

Creating OSLC links (through the Create DHTrace operation)

 Note
In the 19.0 and later versions, the Create OSLC link operation is not displayed and is used
through the Create DHTrace operation instead of the Operation drop-down list in Cameo
DataHub Explorer.

OSLC links can be created when you open an IBM® Rational® DOORS® Next Generation Data Source in
DataHub. You can create OSLC links from IBM® Rational® DOORS® Next Generation artifacts repository
by using the Create DHTrace operation from the Operation drop-down list in Cameo DataHub
Explorer.

Typically, an OSLC link is a relation between two lifecycle artifacts. Relationships are modeled with two
types of properties: link property and backlink property. The following relations have properties listed
in the table below

Relation Link property Backlink property

implementation oslc.implementedBy

constrain oslc.constrains oslc.constrainedBy

elaborate oslc.elaborates oslc.elaboratedBy

satisfy oslc.satisfies oslc.satisfiedBy

affect oslc.affectedBy

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 20

 Relation Link property Backlink property

specify oslc.specifies oslc.specifiedBy

track oslc.trackedBy

decompose oslc.decomposes oslc.decomposedBy

validate oslc.validatedBy

Related pages

• Copy Data operation (see page 78)

• Copy Data with Sync operation (see page 82)
• Copy Data with DHTrace operation (see page 92)
• Create Sync operation (see page 95)
• Create DHTrace operation with OSLC links (see page 99)

DataHub tree
DataHub tree is composed of nodes, each of which represents either a node or a connected Data
Source. Data in the DataHub tree are arranged hierarchically in a tree structure. It represents all the
data that DataHub contains at that time.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 21

 The DataHub tree.
Related pages

• Data Source synchronization (see page 229)

• Displaying MagicDraw Data Sources (see page 45)
• Removing a Data Source (see page 70)

DataHub Explorer buttons and icons

The following table lists the icons in the DataHub Explorer tab.

Ic Name Description
o
n

Cameo DataHub The DataHub root.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 22

 Ic Name Description
o
n

MagicDraw® The MagicDraw® driver to connect to a MagicDraw® project.

Driver

Drivers The drivers to connect to the other tools (CSV, IBM® Rational® DOORS®, IBM® Rational®
DOORS® Next Generation).

Toggle showing Hides all disconnected Data Sources in the DataHub Explorer tab.
only
connected Data
Sources

Toggle showing Displays all Data Sources in the DataHub Explorer tab.
all Data Sources

Add Data Source Opens the Add Data Source dialog.

button

Synchronize Starts the synchronization process.

button

Disconnected The Data Source (of MagicDraw®, IBM® Rational® DOORS®, or a CSV file) disconnected
Data Source from its source.

Folder, Package A folder or a Package.

DOORS Link A link in the IBM® Rational® DOORS® application.

MagicDraw® A link in the MagicDraw® application.

relationship

Item Any items, e.g., an IBM® Rational® DOORS® object, MagicDraw® element, or CSV item.

Create OSLC Opens the OSLC Query Editor dialog, allowing you to perform basic and advanced
Query queries to an IBM® Rational® DOORS® Next Generation Data Source. This becomes
button enabled when you add an IBM® Rational® DOORS® Next Generation Data Source.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 23

 Ic Name Description
o
n

DataHub Deletes an item when the item is dragged onto the icon. A confirmation dialog
explorer Trash appears before deleting the item.
Icon

DataHub Properties tab

The DataHub Properties tab shows the properties (names and values) and associations of a selected
node in DataHub Explorer that you can edit and save their value. You can also open, update, or delete
the following items in the DataHub Properties tab.

• MagicDraw® elements
• DOORS objects and modules
• CSV items
• IBM® Rational® DOORS® Next Generation Artifacts

To open the DataHub Properties tab in MagicDraw®, do one of the following

• Right-click a node in DataHub Explorer and click Properties.

• Double-click a node in DataHub Explorer.

The DataHub Properties tab opens in MagicDraw®, and the properties of the selected item are
displayed.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 24

  Note
• The DH Links panel opens when the DataHub Properties tab is open.
• Read-only and multi-valued properties cannot be edited. However, you can edit multi-
valued properties through the Specifications window.

The table below explains the function of each icon in the DataHub Properties tab in MagicDraw®.

Ic Name Function
o
n

Categorized Shows all property names by category.

View

Alphabetical Shows all property names in an alphabetical order.

View

Show Shows description of each property.

Description

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 25

 Ic Name Function
o
n

Expand Shows all property names and values.

Collapse Hides all property names and values.

Save Saves changes made to a property name or value. The button is enabled when the
value of the property changes.

DH Links panel
Information about links between elements is arranged in a tabular form in the DH Links panel. This
tab shows the detail of all the links you have added to items from the DataHub Operation drop-down
list.

DHLink maintains synchronization between source and target elements, either bidirectional or
unidirectional.

To open the DH Links panel in MagicDraw®

• From the MagicDraw main menu, click Tools > DataHub > DHLink Panel. The DH Links panel
opens.

The DH Links panel contains icons and a table. Each node in the table has a shortcut menu (see page 27)
called the Actions menu that helps you manage the node and its relations.

The following table provides the description of each column in the table in the DH Links panel.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 26

 Value Description

Data Source and its driver name The name of the Data Source in MagicDraw.
(MagicDraw)

Direction The direction of DHLink synchronization.

Data Source and its driver name The name and the driver of the Data Source.
(other drivers)

Status The status of the node (Modified, Moved, Deleted or

Synchronized).

Property button
Contains the Property button that opens up the node’s
properties panel.

 Tip
You can click the Property button to see more details of the target node.

Related page

• DH Links panel shortcut menu and Sync Status icons (see page 27)

DH Links panel shortcut menu and Sync Status icons

You can right-click an item in the table in the DH Links panel to open a shortcut menu. This
shortcut menu allows you to execute specific operations on a node in the panel.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 27

 The Shortcut menu in the table in the DH Links panel.
The table below explains the functions of the DH Links panel shortcut menu.

Command Function

Select MagicDraw project name Selects the element in the MagicDraw Containment tree.
node in Application

Select MagicDraw project name Selects the MagicDraw node in DataHub/Alias Explorer.
node in DataHub Explorer

Select Data Source name node in Selects the node in the original application, e.g., the node originally from
Application DOORS will be opened in the DOORS client application.

Select Data Source name node in Selects the node from other Data Sources, e.g., DOORS, in DataHub/Alias
DataHub Explorer Explorer.

Change Direction (only for root Changes the current direction of synchronization: Two-way Sync, Sync
nodes) from MagicDraw, and Sync to MagicDraw.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 28

 Command Function

View Schema Map Opens the View Schema Map (see page 202)dialog.

The View Schema Map dialog.

Exclude Node (not for root nodes) Skips the synchronization of the selected node and its child nodes.

Include Node Includes the selected node and its child nodes for the synchronization.

Update Pending DHLink (for Synchronizes the node by updating the pending DHLink.
Pending Update items)

Discard Update (for Pending Synchronizes the node by discarding the DHLink.
Delete items)

Remove DHLink Removes the selected DHLink.

 Note
• DataHub cannot recreate a node if its parent does not exist.
• You can perform the Change Direction and Remove DHLink command(sync relation)
on a root node only.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 29

You can click the Sync Status icons to filter the status of synchronization of the nodes. The DH Links
panel displays only the DHLinks with the Sync status you have selected from the specified Sync Status
icons.

The Sync Status icons on the DH Links panel.

All the Sync Status icons are listed in the following table

Button Color sync Status Meaning

Green Synchronized Displays only the DHLink of the Synchronized status.

Blue Orphan Displays only the DHLink of the Orphan status.

Red Pending Delete Displays only the DHLink of the Pending Delete status.

Yellow Pending Update Displays only the DHLink of the Pending Update status.

Grey Excluded Displays only the DHLink of the Excluded status.

DataHub alias
An alias can be created from any nodes or Data Source. DataHub Alias Manager (see page 31) stores all
available aliases, and they can be either accessed or removed from there.
Related page

• Alias Manager (see page 31)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 30

Alias Manager
DataHub Alias Manager contains a list of all available aliases. It stores these aliases for later use, and
you can either access or remove them.

To open Alias Manager

• From the MagicDraw main menu, click Tools > DataHub > Alias Manager. The Alias Manager
dialog opens.

1 DataHub Alias Manager

Compatible data sources

A Data Source is typically a reference to some data. Data in a DOORS repository can be setup as a Data
Source from within DataHub. Following is the list of possible data sources with their compatible
versions:

• A MagicDraw® project
• An IBM® Rational® DOORS® Next Generation (4.x, 5.x, and 6.x up to 7.0.2)
• An IBM® Rational® DOORS® Client (8.0-8.3 and 9.0-9.7)
• ENOVIA Requirements (Up to 22x FD01)
• A CSV file repository
• An OSLC Provider

Schema map and mapping options

DataHub provides the two mapping modes to simplify the way you map source and target nodes as
follows

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 31

 • Group type mapping mode
• Individual type mapping mode
These schema mapping methods are accessible through the Copy Data dialog, Copy Data with Sync
dialog, and Copy Data with DHTrace dialog. Additional options, e.g., excluding unmapped nodes, are
also available.

There is also a Define target type from attribute value (see page 34) mapping mode only available in group
type mapping mode. Once you use the Define Target Type from Attribute Value mapping mode,
DataHub saves it as the default mode and activates it the next time you copy the same type of data. In
this case, the Copy Data dialog, Copy Data with Sync dialog, or Copy Data with DHTrace dialog does
not open.

Related pages

• Individual type mapping (see page 32)

• Group type mapping (see page 33)
• Define target type from attribute value mapping (see page 34)
• Schema Map Manager (see page 35)
• Schema map templates (see page 36)
• Exporting schema maps as new templates (see page 36)

Individual type mapping

 For individual type mapping, you must start by mapping the parent node first, following the
sequence. Please make sure to map the parent before moving on to the children nodes.

The individual type mapping feature in DataHub arranges all nodes into a tree structure. You can select
a node from the source node and map it to a type in the target node. The auto-mapping function of
DataHub allows you to map similar node types automatically and change the target type that has been
mapped.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 32

 Individual type mapping mode in the Copy Data with Sync dialog.

Group type mapping

The default mapping type in DataHub is group type mapping. If you prefer mapping node types to
mapping the nodes one-by-one before copying and/or synchronizing them, you can select the Group
Type Mapping mode from the Mapping Mode drop-down list. It arranges all nodes according to their
types to allow you to see the grouped types instead of individual nodes arranged in a tree structure.
You can select a type from the source tree and map it to another type in the target tree.

 Note
Each formal module in DOORS is categorized as one node type.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 33

 Group type mapping mode in the Copy Data with Sync dialog.

Define target type from attribute value mapping

The Define Target Type from Attribute Value mapping mode is the capability of specifying or
defining type of nodes to map in the target by using a node’s attribute value in the source as the
condition. This mode is available in the Copy Data dialog, Copy Data with Sync dialog, and Copy Data
with DHTrace dialog for the Group Type Mapping option. The Define Target Type from Attribute
Value mapping mode makes it possible to select the attribute’s values of a node and map them to
multiple target types.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 34

 The Define Target Type from Attribute Value option in the Copy Data with Sync
Dialog.

Schema Map Manager

You can Schema Map Manager (see page 266) to edit attribute mapping. When the DHLinks between
nodes and attributes have been created, Schema Map Manager saves the mapped nodes and
attributes. You can edit the attribute mapping for a specific schema mapping. You can also export the
mappings in XML format and share them with other users.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 35

 Schema Map Manager

Schema map templates

DataHub provides schema map templates in each application, e.g., MagicDraw® and DOORS, by
default. The templates are available in the Cameo DataHub Schema Map Manager dialog. They allow
you to select a type of node to do mapping in the target application and edit the attributes. You can
also select and set a target type as the default one so that the next time you map similar data attributes
from any sources, they will always be mapped to the same target type.

Exporting schema maps as new templates

You can now export the previously defined mappings of particular modules as new templates for
Rational DOORS Data Sources to be effective when importing new modules.

DataHub usually provides mapping template, e.g., the pre-mappings between DOORS objects and
SysML Requirements with some properties mapped. However, you can now export the mappings done
with a particular module to be a template. Therefore, when you import a new module, the new
template is used.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 36

To export a schema map as a new template

1. On the main menu, click Tools > DataHub > Schema Map Manager. The Schema Map
Manager dialog opens. There are some properties with pre-mappings.

2. Click Export. The Export Schema Map Wizard appears.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 37

 3. Select the source and target driver of the map and click Next.
4. Select the box(es) in front of the maps and click the selected map to choose the DOORS type
object to change it to a generic type. Click Next.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 38

 5. Name the schema and the exported file. Click Finish.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 39

To import a schema map

1. On the main menu, click Tools > DataHub > Schema Map Manager. The Schema Map
Manager dialog opens.
2. Click Import and choose the schema map file. The template will be updated with the new
mapping.

Driver deployment
DataHub supports driver deployment for the DOORS client. This enables the DOORS application to
activate its DataHub menu items and also allows DataHub to create DOORS Data Sources.

 Note
• Driver deployment copies the DXL script file into the DOORS addin folder and updates
the registry for DOORS to recognize the addin path. Therefore, you must run MagicDraw
or Cameo products as an administrator to allow these operations during driver
deployment.
• You must close the DOORS application before driver deployment since folders are write-
protected when the application is active.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 40

To deploy the DOORS driver in DataHub

1. From the MagicDraw® main menu, click Tools > Datahub > Driver Deployment. The Driver
Deployment dialog appears.

2. Select the DOORS version you would like to add and then click .
3. A browse dialog opens. You must navigate to the DOORS installation directory to load the driver.

OSLC support
Since Cameo DataHub 18.1, DataHub has begun implementing features to support OSLC interactions.
Open Services for Lifecycle Collaboration (OSLC) is a community standardizing the way that life cycle
tools work together. With support for OSLC, DataHub can easily communicate with other software such
as IBM® Rational® DOORS® Next Generation, which also supports OSLC integration. Therefore, you can
share and use linked data, analyze, track, and explore them via OSLC links between DOORS Next
Generation artifacts and DataHub data nodes.

DataHub supports the following

• OSLC Link support for IBM® Rational® DOORS® Next Generation

• OSLC Query support for IBM® Rational® DOORS® Next Generation

Add-on features
The current release of DataHub features enhanced capabilities and emphasizes more usability. The
Conflict Dashboard keeps track of the changes of on both sides of the source and target nodes, which
allows you to consider data synchronization. The text search function enables convenient searching for
data or items in DataHub Explorer and Alias Manager. Available filtering inactive Data Sources makes it
easier for you to focus on working active Data Sources, and the data copy progress bar shows the
remaining percentage to complete the data copying operation.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 41

Related pages

• Text search in DataHub Explorer and Alias Manager (see page 42)
• Inactive Data Source filter (see page 42)
• Data copying progress bar (see page 43)

Text search in DataHub Explorer and Alias Manager

The text search capability in DataHub Explorer allows you to search for data and items in DataHub.

2 DataHub Explorer Text Search box

Text search capability in DataHub Explorer.

Inactive Data Source filter

The Inactive Data Source Filter button is available on the DataHub Explorer toolbar. You can use
this filter to filter out all inactive Data Sources from the DataHub Explorer tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 42

3 DataHub Explorer toolbar - Filtering inactive sources button

Inactive Data Source Filter button on the DataHub Explorer toolbar.

Data copying progress bar

When copying data, DataHub shows the progress through its progress bar.

4 DataHub Copy progress bar

The progress bar when DataHub copies data.

Opening DataHub Explorer

To open DataHub Explorer

1. Create a new MagicDraw® project or open an existing project.

2. From the MagicDraw main menu, click Tools > DataHub > DataHub Explorer. The DataHub
Explorer tab (see page 17) opens.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 43

5 DataHub Explorer

 Note
• Nodes under particular drivers in DataHub Explorer also represent nodes in the
applications belonging to the drivers.
• If a driver is correctly started, the name of the driver will appear in the DataHub
Explorer tree. The driver will then connect to data in each of its respective application.

Related page

• DataHub Explorer tab (see page 17)

DataHub basic operations

After installing Cameo DataHub, you can begin to add Data Sources. Data Sources can be added for the
following requirements management systems

• IBM DOORS
• IBM DOORS Next Generation
• CSV Files
Once you have the Data Sources in DataHub open, you can start using more advanced DataHub
features, e.g., copying data and DHLink relations between Data Sources. The synchronization features
of DataHub are also illustrated in this chapter.

Related pages

• Displaying MagicDraw Data Sources in DataHub Explorer (see page 45)

• Customizing module and object label in DataHub Explorer (see page 48)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 44

Displaying MagicDraw Data Sources in DataHub Explorer
By default, MagicDraw® Data Sources are not shown in the DataHub Explorer tab (see page 17). However,
you can display MagicDraw® Data Sources in the DataHub Explorer tree through the Cameo DataHub
Environment options.

To display a MagicDraw® Data Source in the DataHub Explorer tree

1. From the MagicDraw main menu, click Options > Environment. The Environment Options dialog
opens.

2. On the left-hand side of the dialog, select Cameo DataHub in the list.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 45

 3. In the General group of options, clear the Filter a Magic Systems of Systems Architect data
source from the DataHub Explorer checkbox.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 46

 4. Click OK. A MagicDraw® Data Source now appears in the DataHub Explorer panel.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 47

Customizing module and object label in DataHub Explorer

 Note
This customization applies for the entire DOORS Data Source. You cannot customize the node’s
label for only some modules.

To customize the node’s label

1. Right-click a DOORS Data Source and select Customize Module/Object label.

2. The Customize label dialog opens. Enter the name of property that you want to display for the
module and object by placing the property name inside quotation marks. You can append more
properties or add some text, e.g., “Object Identifier”::”Object Heading”. Click OK.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 48

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 49
  Note
When you edit the node’s label, you must reload the tree in DataHub Explorer.

Basic features of DataHub

You will be guided through DataHub basic copying operations from the Operation drop-down list in
Cameo DataHub Explorer including creating OSLC links and DHTraces. There is also more explanation
about creating OSLC queries and copying their results, optionally as SysML requirements.
Related pages

• DataHub Operation drop-down list (see page 51)

• Mapping source and target types to copy data to and from a modelling tool (see page 52)
• Creating OSLC Query operation (see page 54)
• Data Synchronization (see page 54)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 50

DataHub Operation drop-down list
The Operation list in the Cameo DataHub Explorer panel provides several options for you to work
with your data.

Operation drop-down list

The table below briefly explains the functions of the DataHub operations.

Operation Function

Copy Data Only copies the data with child nodes.

Copy Data with Sync Copies data and creates synchronization (DHLinks) between the source and target
nodes. Nodes in the modeling tool are updated or deleted whenever their
corresponding nodes in associated tools are updated or deleted. The newly created
nodes can be transferred to other associated tools as well.

Copy Data with Copies data and creates DHTrace links between the source and target nodes. DHLinks
DHTrace are used to trace the changes.

Create Sync Recreates synchronization (DHLinks) if you lose or delete the DHLinks without
replicating the data.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 51

 Operation Function

Create DHTrace Creates DHLinks between the source and target nodes without copying any data.
(with OSLC links) Creates an OSLC link from an IBM® Rational® DOORS® Next Generation Data Source to a
MagicDraw® element.

 • The parent-and-child relationships are transferred from the source to the target items.
• The dependency relationships from MagicDraw® are also transferred if both the source
and target nodes are selected.
• By default, Copy Data with Sync is selected in the operations list.

Mapping source and target types to copy data to and from a

modelling tool
Data can be copied into the MagicDraw® Containment area from other Data Sources. Data can also be
moved from MagicDraw® into other Data Sources like DOORS and CSV repositories. You can use the
Copy Data, Copy Data with Sync, and Copy Data with DHTrace operations to copy data. While moving
the data, the Copy Data, Copy Data with Sync, or Copy Data with DHTrace dialog prompts you to
map the source and target types as well as their attribute types. After you map the source and target
types, you can copy the data.

To copy data into MagicDraw® or to copy data to other Data Sources

1. Drag the data node to another Data Source, e.g., DOORS.

The export dialog, e.g., Copy Data with Sync (depending on the operation you have selected

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 52

 from the DataHub Operation drop-down list (see page 51)), opens to allow you to map the source
and target attribute.

The detail of each option in the export dialog is explained in the table below.
Option Function

Mapping mode You can either do Individual Type mapping or Group Type mapping. Individual
type mapping allows you to map the individual nodes themselves, and Group
Type mapping allows you to map the node type as a whole.

Set as default The source nodes are mapped to the selected stereotype element type as default.
target type The export dialog will not open when you copy the same type of data next time.

Define Target This mapping option is only available for group type mapping mode. In this
Type from mapping mode, you can specify node values and their target types.
Attribute Value

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 53

 Option Function

Exclude all no- Unmapped nodes will not be copied, and the source nodes will be marked as
mapped nodes excluded with an 'X' symbol. Unmapped nodes are marked with red circles beside
from DHLinks them and the mapped ones have green circles.

Sync Direction Two-way sync, One-way Sync from MagicDraw, and One-way Sync to
MagicDraw. Two-way sync changes the nodes on both ends, while one-way sync
only synchronizes changes from the source node to the target node.

a
2. Choose a mapping type, either individual or group. Map the source types to target types and
map source attributes to target attributes. When the nodes have all been mapped, the red circles
beside them change to green. You can select Exclude all no-mapped nodes from DHLinks the
checkbox to exclude nodes that have not been mapped from being copied.
3. Click OK. The nodes are copied to the MagicDraw® Containment area.
Related page

• DataHub Operation drop-down list (see page 51)

Creating OSLC Query operation

In OSLC, each artifact in the lifecycle, e.g., Requirements, Change Requests, or Test Cases, is identified
by a URI. Each artifact in the lifecycle is an HTTP resource. Standard HTTP methods (GET, PUT, POST,
DELETE) are used to interact with each artifact. When you look up a URI, OSLC queries provide useful
information using the standards (RDF*, SPARQL). Each OSLC resource has an RDF representation. RDF/
XML is mandatory and other representations such as JSON or HTML are common. OSLC lifecycle
artifacts are linked by relationships, e.g., elaborates or elaborated, defined by URIs.

You can construct two types of OSLC queries to query an artifacts repository - simple or basic query
and advanced query based on SQL or SPARQL. You can also find more information about OSLC queries
on the OSLC Specification website10.

Related Pages

• Creating OSLC queries (see page 184)

Data Synchronization
Synchronization is primarily used for keeping track of changes. Data synchronization allows you to track
different types of changes and maintain the consistency of data across nodes in different data sources
and applications. Data synchronization can be categorized into two functional types namely, Data
Source synchronization and Node synchronization. For more information, refer to Synchronization (see
page 226).

To synchronize the data sources

10 http://open-services.net/+

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 54

 1. Open the Cameo DataHub Explorer Panel (see page 17).
2. From the Operation drop-down list (see page 18), select Copy Data with Sync operation (see page 82).
You can also synchronize the data by using Create Sync Operation (see page 95).
You can track the changes and updates done after the synchronization with the help of the Conflict
Dashboard. (see page 233)

User Guide
Welcome to Cameo DataHub user guide!

See the following chapters to learn more about the product and its features or use the search box to
find the information you need:

• Working with DataHub and modeling tools (see page 55)

• Using DataHub in Teamwork Cloud environment (see page 223)
• Synchronization (see page 226)
• Schema Mapping (see page 264)
• Additional DataHub features (see page 275)

Working with DataHub and modeling tools

DataHub is a fully functional plugin for MagicDraw®, IBM® Rational® DOORS®,
IBM® Rational® DOORS® Next Generation, and CSV files. It allows you to work with the Requirement
management tools mentioned above and provides three following main functions

• Copy
• Link
• Synchronize
You can copy Requirement objects, and link them to one another as well as system models, for
example, Use Cases and Diagram elements. You can create OSLC links and synchronize the
repositories. This chapter also explains OSLC support and how to use it with Cameo DataHub.

To use Cameo DataHub, make sure you have deployed it in your application (see page 40). The DataHub
plugin works with both local and Teamwork Cloud projects11.

 Note
• To load a MagicDraw® Teamwork Cloud project as a Data Source in DataHub, you must
first log on to MagicDraw® Teamwork Cloud.
• Only the Locked For Edit Teamwork Cloud project elements can perform DataHub
functions, e.g., copying and creating OSLC links and queries or synchronizing data.

Related pages

• Customizing DataHub options (see page 56)

• Working with the DataHub Explorer tree (see page 69)
• Operations in DataHub Explorer (see page 77)

11 https://docs.nomagic.com/display/MD2024xR1/Using+Teamwork+Cloud

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 55

 • Working with Data Sources (see page 118)
• Working with OSLC features (see page 171)
• Creating links between elements (see page 194)
• Requirement Mapping (see page 202)
• Working with the DHLink summary and generating reports (see page 213)

Customizing DataHub options

You can specify Cameo DataHub environment options in the Environment Options dialog of your
modeling tool.

To access Cameo DataHub environment options in a modeling tool

1. In the main menu of your modeling tool, select Options > Environment.
2. When the Environment Options dialog opens, select the Cameo DataHub option group on the
left side of the dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 56

Cameo DataHub environment options are divided into the following groups:

• Confirmation (see page 57)

• General (see page 61)
• IBM Rational DOORS (see page 62)
• IBM Rational DOORS Next Generation (see page 64)
• ENOVIA Requirements (see page 66)
• OSLC Provider (see page 68)

Confirmation
You can adjust the behavior of the Confirmation popup dialogs in DataHub through the Confirmation
option group.

To enable or disable the Cameo DataHub Confirmation dialogs in MagicDraw®

1. Open the Cameo DataHub Options (see page 56) dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 57

 2. Go to the Confirmation group and select or clear the checkbox as per your requirement.
3. Click OK.

The following table explains each Confirmation option group in the Cameo DataHub Options dialog.

Option Function

Show a confirmation dialog when Opens a confirmation dialog before synchronizing data.
synchronizing data.

Show a warning dialog about the Opens a warning dialog that copying or synchronizing data erases
lost Rich Text format when copying the Rich Text format.
or synchronizing data.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 58

 Option Function

Show a confirmation dialog when Opens a confirmation dialog before deleting a node.
deleting node action.

Show a confirmation dialog when Opens a confirmation dialog before deleting a node whose status is
deleting Pending Delete status. PendingDelete.

Show a confirmation dialog when Opens a confirmation dialog before deleting a schema map.
deleting the schema map.

Show a warning dialog when the Opens a warning dialog when editing a schema used in another
schema being edited is used in project.
another project.

Show a warning dialog when Opens a warning dialog before copying data when some nodes
copying data. have not been completely mapped.

Show a warning dialog when saving Opens a warning dialog about saving a property value and erases
a text property that causes the format.
formatting lost.

Show a warning dialog when Opens a warning dialog that synchronizing data relocates some
synchronizing at another side of the out-of-scope nodes on the other side within the DHLink.
Out of Scope node.

Show a confirmation dialog when Opens a confirmation dialog before removing the DHLink of the
removing DHLink. selected node.

Show a confirmation dialog when Opens a confirmation dialog before removing DHLinks of the
removing DHLinks recursively. selected node and its hierarchy.

Show a confirmation dialog when Opens a confirmation dialog before overwriting a schema map.
replacing the existing map.

Show a confirmation dialog when Opens a confirmation dialog before updating all pending DHLinks
updating all pending DHLinks of the selected node and its hierarchy.
recursively.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 59

 Option Function

Show a confirmation dialog when Opens a confirmation dialog before updating all pending DHLinks
updating all pending DHLinks. of the selected node.

Show a confirmation dialog when Opens a confirmation dialog before updating a node whose status
updating the Pending Update is PendingUpdate.
status.

Show a confirmation dialog when Opens a confirmation dialog before discarding the pending
discarding pending DHLinks. DHLinks.

Show a confirmation dialog when Opens a confirmation dialog before discarding the pending
discarding pending DHLinks DHLinks recursively.
recursively.

Show a confirmation dialog when Opens a confirmation dialog before discarding the orphan DHLinks.
discarding orphan DHLinks.

Show a confirmation dialog when Opens a confirmation dialog before discarding the orphan DHLinks
discarding orphan DHLinks recursively.
recursively.

Show a confirmation dialog when Opens a confirmation dialog before removing orphan DHLinks.
removing orphan DHLinks.

Show a confirmation dialog when Opens a confirmation dialog before removing orphan DHLinks
removing orphan DHLinks recursively.
recursively.

Show a confirmation dialog when Opens a confirmation dialog before excluding entities recursively.
excluding entities recursively.

Show a confirmation dialog when Opens a confirmation dialog before excluding entities.
excluding entities.

Show a confirmation dialog when Opens a confirmation dialog before including entities recursively.
including entities recursively.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 60

 Option Function

Show a confirmation dialog when Opens a confirmation dialog before including entities.
including entities.

 Note
• An out-of-scope node is a node that has been relocated outside the root node.
Therefore, the node hierarchy is changed.
• Synchronizing on the side where some out-of-scope nodes exist does not change the
node hierarchy of the related nodes on the other side. Therefore, a warning message
does not open, but synchronizing from the other side moves the out-of-scope nodes to
their original locations.

General
DataHub allows you to select default options for mapping type and policy, filter, and synchronization in
the General environment option group.

To modify the DataHub General environment options

1. Open Cameo DataHub environment options (see page 56).

2. Open the General option group and update the required options.
3. Click OK.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 61

 The following table explains the details of Cameo DataHub options in the General option group

Option Function

Synchronize data when saving project Enables automatic synchronization with MagicDraw® when
you save a project.

Set the Group Type Mapping as the Sets the default mapping to group type mapping when
default mapping copying data.

Filter a MagicDraw data source from the Hides the display of MagicDraw® Data Sources in DataHub
DataHub explorer Explorer and shows the Data Sources when cleared.

Auto layout when copy to diagram The diagram layout is adjusted automatically to fit the newly
added element.

Show copy dialog when import If True, opens the Copy Data with Sync dialog while importing
the data.

Mapping policy Shows options for displaying the mapping dialog that you can
select in the drop-down list, as follows:

• Always show the mapping dialog

• Show mapping for elements without default
mapping
• Show mapping for elements that cannot be
automatically mapped
• Show mapping for elements with an unknown
data type
• Treat no-default mapping element as exclude.

Database Compression Algorithm Enables you to choose a compression engine to compress

project files to reduce the model size. You can choose
between Zip and BZip2 engines.

Save HTML images from the data source Saves HTML images from the data source in the project as
in the project as attached files attached files.

IBM Rational DOORS

This section explains the IBM Rational DOORS setting in the Cameo DataHub Options dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 62

To configure the IBM Rational DOORS setting

1. Open the Cameo DataHub Options (see page 56) dialog.

2. Go to the IBM Rational DOORS group and update the required options.

The following table explains the IBM Rational DOORS options in the Cameo DataHub Options dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 63

 Option Function

DataHub DOORS DXL file location For DOORS integration, DataHub provides options to
configure how the DXL script is used. There are two options
for the DOORS DXL file locations as follows:

• Deployed folder
For each DXL request, DataHub will look for a DXL
command stored in the DOORS addins folder.
The DXL script file will be available after you have
completed driver deployment (see page 40) for
DOORS.
• DataHub plug-in folder
For each DXL request, DataHub will look for a DXL
command stored in the DataHub plugin folder.
The DXL script file will be available by default.

Show the 'Go To DOORS object satisfied by the If True, enables the Go To DOORS object satisfied by the
selected element' menu selected element menu.

Keep module open If True, leaves the DOORS module open.

Use read only DOORS DXL file If True, opens the DOORS module in read-only mode.

Ignore DXL attribute If True, ignores the DXL attributes whose value is populated
from the DXL script.

Do not use the DXL file (commands are sent on If True, sends each DXL request directly to DOORS without
requests) using the DXL script file.

 Note
If the configuration of DXL commands from the
script file is restricted with specific security
settings that limit the access to the selected
folders at DataHub DOORS DXL file location on
some machines, you can select the Do not use the
DXL file (commands are sent on requests)
option to solve this problem.

IBM Rational DOORS Next Generation

This section explains the IBM Rational DOORS Next Generation preference in the Cameo DataHub
Options dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 64

To specify the number of maximum concurrent connections for IBM Rational DOORS Next Generation

1. Open the Cameo DataHub Options (see page 56) dialog.

2. Go to the IBM Rational DOORS Next Generation option group and update the required
options.
The following table explains the IBM Rational DOORS Next Generation options in the Cameo DataHub
Options dialog.

Option Function

Maximum concurrent Takes a numerical value for the maximum number of concurrent
connection connections.

Show all GC data source If True, all Global Configuration data sources are visible on the Cameo
DdataHub Explorer panel, including removed and inactive data sources.

Use DataHub JxBrowser OBSOLETE

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 65

 Option Function

Use JxBrowser incognito mode Enables Incognito mode for the default profile. Incognito mode stores user
data, such as browsing history, cookies, and site data in the memory.

Use JxBrowser GPU JxBrowser renders content using GPU (Graphical Processing Unit) and
displays it directly.

Use JxBrowser sandbox If True, JxBrowser supports Chromium Sandbox on Windows.

ENOVIA Requirements
This section explains the ENOVIA Requirements setting in the Cameo DataHub Options dialog.

To configure the ENOVIA Requirements setting

1. Open the Cameo DataHub Options (see page 56) dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 66

 2. Go to the ENOVIA Requirements group and update the required options.
3. Click OK.

The following table explains the ENOVIA Requirements options in the Cameo DataHub Options dialog.

Option Function

Maximum Takes a numerical value for the maximum number of concurrent connections.
concurrent
connection

Driver mode Integrated mode enables you to connect to ENOVIA from the 3DEXPERIENCE menu.
DataHub mode enables you to add the ENOVIA data source from the Cameo DataHub
Explorer panel.

Use JxBrowser Enables the Incognito mode for the default profile. Incognito mode stores user data,
incognito mode such as browsing history, cookies, and site data in the memory.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 67

 Option Function

Use DataHub OBSOLETE

JxBrowser

Use JxBrowser GPU JxBrowser renders content using GPU (Graphical Processing Unit) and displays it
directly.

Use JxBrowser If True, JxBrowser supports Chromium Sandbox on Windows.

sandbox

OSLC Provider
This section explains the Generic OSLC Service Provider preference in the Cameo DataHub
Options dialog.

To specify the number of maximum concurrent connections for the OSLC Provider

1. Open the Cameo DataHub Options (see page 56) dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 68

 2. Go to the Generic OSLC Service Provider option group and update the option.
The following table explains the Generic OSLC Service Provider options in the Cameo DataHub Options
dialog.

Option Function

Maximum concurrent Takes a numerical value for the maximum number of concurrent
connection connections.

Working with the DataHub Explorer tree

While using DataHub to work with Requirements from a project in DOORS or CSV, you must first create
a Data Source. Data sources can be created for IBM® Rational® DOORS®, IBM® Rational® DOORS® Next
Generation, or CSV files.

When you add the Data Source into MagicDraw®, it appears in the DataHub Explorer tree as a Data
Source node.

Related pages

• Closing and opening Data Sources (see page 69)

• Filtering inactive Data Sources (see page 70)
• Removing a Data Source (see page 70)
• Deleting Requirements (see page 70)
• Searching for a text string (see page 70)
• Adding a new node to a Data Source (see page 72)
• Creating Alias (see page 75)
• DataHub Alias Manager (see page 76)

Closing and opening Data Sources

To close an open Data Source

• Right-click a Data Source in the DataHub Explorer tree and choose

 Note
Closing a Data Source doesn’t remove it from the DataHub Explorer tree. This action is only
for deactivation.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 69

To open or activate an inactive Data Source

• Right-click an inactive Data Source and choose .

The Data Source shows as connected.

Filtering inactive Data Sources

To filter out an inactive Data Source

• On the DataHub Explorer toolbar, click the Filter inactive data sources button.

Removing a Data Source

To remove a Data Source

1. Right-click the Data Source to remove and select .

2. You are prompted to confirm the removal action. Click OK.
This option removes the Data Source from the DataHub Explorer tree. It also removes all related
DHLinks and Schema Map information from DataHub.

Deleting Requirements
To delete a Requirement from the DataHub Explorer tree, do one of the following

• Right-click the node you want to delete and select .

• Drag the node onto the DataHub Explorer Trash icon.

A confirmation dialog asking you to confirm the deletion opens. Click OK.

Searching for a text string

To search for text

1. Type the text you want to search into the search box .

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 70

 2. The search results are shown in the DataHub Explorer tree with highlighted texts in accordance
with the used search word.

6 Results of text search - the search item will be highlighted

3. To navigate to the Next Result or Previous Result in the highlighted texts, use the navigation
buttons next to the search box.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 71

Adding a new node to a Data Source
You can use DataHub Explorer to add a new node to a particular application without switching to that
application. In addition, the new node you have added in DataHub Explorer also appears in the
application itself. You can add a new node to any connected Data Sources by using the New Node
command in the DataHub shortcut menu. Types of nodes vary, depending on the driver and the parent
of the new node.

To add a new node to a specific Data Source

1. Right-click a node and select New Node.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 72

 2. The New Node dialog opens. Select a new node type from the tree view and click Next.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 73

7 Available Node Types under Data Node

3. Specify the new node’s properties details and click Finish.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 74

8 New Node wizard interface - step two - mapping node attributes

Creating Alias
To create Alias Explorer

• Right-click a node that you want to create the selected scope and click Create Alias. The Alias
Explorer tab opens, showing only the nodes in the scope that you have selected.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 75

Related Pages

• DataHub Alias Manager (see page 76)

DataHub Alias Manager

When an Alias is created, it is saved in Alias Manager. You can reopen or remove an Alias you have
created through the Alias Manager dialog.

To manage an existing Alias

1. On the main menu, click Tools > DataHub > Alias Manager.
2. The Alias Manager dialog opens. Expand each driver to see all of the Aliases under each driver.

To open or remove an Alias

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 76

 • Select an Alias. Click to open the selected Alias or to delete it.

 Warning
The created Alias is displayed in Alias Manager only when the related Data Source is
connected.

Operations in DataHub Explorer

The Operation list in the Cameo DataHub Explorer panel provides several options for you to work
with your data.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 77

 Operation drop-down list
The table below briefly explains the functions of the DataHub operations.

Operation Function

Copy Data Only copies the data with child nodes.

Copy Data with Sync Copies data and creates synchronization (DHLinks) between the source and target
nodes. Nodes in the modeling tool are updated or deleted whenever their
corresponding nodes in associated tools are updated or deleted. The newly created
nodes can be transferred to other associated tools as well.

Copy Data with Copies data and creates DHTrace links between the source and target nodes. DHLinks
DHTrace are used to trace the changes.

Create Sync Recreates synchronization (DHLinks) if you lose or delete the DHLinks without
replicating the data.

Create DHTrace Creates DHLinks between the source and target nodes without copying any data.
(with OSLC links) Creates an OSLC link from an IBM® Rational® DOORS® Next Generation Data Source to a
MagicDraw® element.

 • The parent-and-child relationships are transferred from the source to the target items.
• The dependency relationships from MagicDraw® are also transferred if both the source
and target nodes are selected.
• By default, Copy Data with Sync is selected in the operations list.

Related Pages

• Copy Data operation (see page 78)

• Copy Data with Sync operation (see page 82)
• Copy Data with DHTrace operation (see page 92)
• Create Sync operation (see page 95)
• Create DHTrace operation with OSLC links (see page 99)
• Compatible data sources (see page 31)

Copy Data operation

The DataHub Copy Data dialog allows you to copy data without synchronization. Copying data works
like the copy and paste operation. If the node you want to copy does not have any default Schema Map,
you must resolve any unmapped nodes through the Copy Data dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 78

To copy data from a source node to a target node

1. From the Operation drop-down list in Cameo DataHub Explorer, select Copy Data.

2. Drag a source node from Cameo DataHub Explorer to a target node in the MagicDraw
Containment tree.

9 Copying data by dragging a source node to target

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 79

 The Copy Data dialog opens.

3. Start mapping the source node attributes to target attribute types. You see the node color
changing from a red circle to a green one, which means the node and its attributes have been
mapped to a target type. The OK button becomes enabled at this point. Click OK to finish the
copying process.

The functions in the Copy Data dialog are explained in the table below.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 80

 Component Function

Mapping Mode Switches between Individual Type Mapping and Group Type Mapping. The Mapping
Mode drop-down list shows the default type that you selected through the Options
dialog.

Source Tree Specifies a data tree of the sources that are copied. You need to specify a target type
for every source type.

Identifies a node whose source type has already been resolved.

Identifies a node whose source type needs to be resolved before copying.

Identifies the following items as

• a node that is not copied since the target type does not support
any children.
• a link that is not copied since the source and/or the target type
does not support the link.

The following three rows are for the Define Target Type from Attribute Value mapping mode option.

Define Target Maps by using the Define Target Type from Attribute Value mode. If you select this
Type from mode, you need to define the values and specify the target types of each value in the
Attribute Value provided table. This mode is enabled in Group Type Mapping only.

Attribute Selects an attribute of a source node and define its values and a target type. The
selected attribute is not available to be mapped for the Source Attribute in the
Schema Map table.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 81

 Component Function

Define Value Defines the values of a selected attribute and the target type of each value. The table
(below Attribute) consists of the following columns

• Default
Specifies a default target type. If an attribute value does not
match any mapped values when copying data or creating a
relation, DataHub uses the default target type.
• Priority
Specifies the priority of a target type. It is used when a defined
attribute has multiple values. The first target type on the list has
the highest priority and is always selected first in the mapping
process.
• Value
Selects a value for a target type. If a selected attribute is an
Enumeration, you can choose the values from the drop-down
list.
• Target
Defines a target type for a selected value.

Quick search Finds a particular type that contains the specific searched text.

Target Type tree Shows all types that are allowed to be added according to the type you have selected
in the Data Type tree.

Set as default Sets a selected target type to be the default when the same mapping source attribute
target type is selected next time.

Schema Map Maps source attributes with target attributes and uses them in data synchronization.

Edits a Schema Map by selecting the attributes in the provided Schema Map table.

Starts copying the selected target type and Schema Map.

Cancels the copying action.

Copy Data with Sync operation

When you select this operation, a DHLink for synchronization is added to the data. It maintains the
structure and data of the elements within the node. During data synchronization, DataHub searches for
any new nodes and deleted nodes. If it finds any new nodes or deleted nodes within the scope on one

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 82

side, DataHub copies them to the other side and create a synchronization relation between them or
deletes them from the other side.

To Copy Data with Sync

1. From the Operation drop-down list in Cameo DataHub Explorer, select Copy Data with Sync.
2. Drag a source node to a target node.

10 Drag and drop a source node to target in Copy Data with Sync operation mode

3. The Copy Data with Sync dialog opens. When the nodes and their attributes have been
mapped to their respective target types, click OK.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 83

  Note
• The mapping process also includes two target types: and
.
• The target type is available for the Individual Type Mapping mode
only. You can see the type in the Target Type tree in the Copy Data
with Sync dialog.
• The target type is available for both the Individual Type Mapping mode
and Group Type Mapping mode. You can see the type in the Target Type
tree only in the Copy Data with Sync dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 84

 • You can exclude nodes in the Copy Data with Sync dialog by selecting the
option and selecting the target
type. This target type marks the unmapped nodes with an Exclude status that will not be
copied.
• Alternatively, you can create the schema mapping for the selected nodes as Exclude by
selecting the target type.
• If you want to include unmapped nodes, go to the DH Links panel, right-click in the
panel, and select Include Node.

The table below summarizes the components of the Copy Data with Sync Dialog.

Component Function

Sync Direction Selects which direction to synchronize data from, either unidirectional or
bidirectional:

• : Synchronizes data in both directions.

• : Synchronizes the other Data Source

with the MagicDraw Data Source. This option appears only when
one of the sides is a MagicDraw Data Source.
• : Synchronizes the MagicDraw Data
Source with the other Data Source.

Mapping Mode Switches between Individual Type Mapping and Group Type Mapping. The Mapping
Mode drop-down list always shows the default type that you have selected through
the Cameo DataHub Options dialog.

Source Type tree Specifies a data tree of the source that is to be copied. You must specify a target type
for every source type.

Identifies a node whose source type has already been resolved.

status icon

Identifies a node whose source type needs to be resolved before copying. It refers to
status icon
either a node that needs to be mapped or a node that needs to be excluded from the
DHLink.

Identifies the following

status icon
• A node that will not be copied since the target type does not
support adding any children.
• A link that will not be copied since the source and/or the target
type does not support creating links.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 85

 Component Function

Identifies the copied node having its parent copied as a node that has already been
mapped and is now locked since it has a DHLink sync relation.

Define Target Maps by using the Define Target Type from Attribute Value mode. If you select this
Type from mode, you must define the property values and specify the target types of each value
Attribute Value in the provided table.

 Note
The Define Target Type from Attribute Value mode is enabled in Group
Type Mapping only.

Attribute Selects an attribute of a source node to define its values and a target type.

 Note
The selected attribute is not available to be mapped for the Source
Attribute in the provided schema map table.

Define Value table Defines the values of the selected attribute and the target type of each value. The
(below the table has four columns as follows:
Attribute drop-
down list) • Default
Specifies the default target type. If an attribute value does not
match any mapped values when copying data or creating
relations, DataHub uses the default target type.
• Priority
Prioritizes the selection order in the mapping process. It is
used when a defined attribute has multiple values. The first
target type on the list has the highest priority and is always
selected first in the mapping process.
• Value
Selects a value for a target type. If the selected attribute is an
Enumeration, you can choose the values from the provided
drop-down list.
• Target
Defines a target type for the selected value.

Exclude all non- Excludes all nodes that you select from data synchronization.
mapped nodes
from DHLinks

Quick search text Finds a particular type containing specific text.

box

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 86

 Component Function

Target Type tree Shows all types allowed to be added according to the type you have selected in the
Source Type tree. The tree comes from the driver and a Cameo DataHub client shows
the tree accordingly.

Unmaps the selected nodes in the Source Type tree. Unmapped nodes is displayed in
red.

Skips and creates the schema mapping for the selected nodes as Exclude.

Set as default Allows a Cameo DataHub client to create the same type of the target when a source
target type type is selected.

 Note
If the mapping has already existed in the system, the new target type
overwrites the old one, and the Schema Map dialog does not open.

Edits a schema mapping by selecting the attributes in the provided schema map
table.

Starts copying with the selected target type and schema mapping.

Cancels the copying operation.

To copy data from DataHub Explorer to the MagicDraw® Containment tree

1. From the Operation drop-down list in DataHub Explorer, do one of the following
• Select Copy Data to copy data only.
• Select Copy Data with Sync to copy data and create synchronization.
2. Drag a node from DataHub Explorer to an element in the MagicDraw Containment tree.
The Copy Data dialog opens and shows the mapping mode and options for mapping the source
and target types.

 Note

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 87

 You can also drag a node from DataHub Explorer into the MagicDraw® diagram pane.
The dragged node is displayed as an element. Any nodes that have not been mapped to
a type in the target tool is shown with a red circle.

11 Dragging a Node to the MagicDraw Diagram Pane

The dragged nodes from DataHub Explorer into the MagicDraw diagram pane are displayed as
elements.

 Information
If you want to copy a DHLink (a MagicDraw® relation or a DOORS link), you must copy all
the parent nodes in this relation. If only one parent node is copied, the DHLink will not
appear.

 Tip
You can get a properly arranged diagram by using the MagicDraw® Layout menu. From
the MagicDraw main menu, click Layout > Quick Diagram Layout to rearrange or
reorganize the diagram.

3. To resolve an unmapped node (a node with a red circle), select it from the Source Type tree and
choose a target type that is available on the list on the right side of the dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 88

  Tip
• Due to the DataHub support of stereotypes, if you have the same MagicDraw®
data type with different stereotypes, you can map these two nodes using a
different schema.
• You can also map customized stereotypes. When you have created the nodes,
reload the Data Sources. The customized stereotypes becomes visible in DataHub
Explorer.

4. Select the check box if you want your nodes to be automatically

mapped to target types for the same type of data, without mapping them again in the Copy
Data dialog.
5. Click any cells of the target attribute and select the target attribute from the provided drop-down
list to be mapped with the source attribute. When the type and attributes are mapped, the color
of the circle on the source node changes from red to green.
6. Continue mapping all the types of the source node, and then click OK to copy them.

 Tip
• The Copy Data and Copy Data with Sync operations use the default templates in
Schema Map Manager. If you want to map a source node with other element
types, you must edit the default schema mapping.
• DataHub supports mapping multi-valued attributes by using the multiplicity of
models. Therefore, if you map the multiple attribute values to the multi-valued
target attributes, you must create customized stereotypes and properties to apply
to the particular target nodes.
• To map the source node’s attribute to the multi-valued attribute of the target
node, you must select the target node that uses the stereotype node and select
the stereotype property.

7. When the data has been copied successfully, the Copy Data with Sync Summary dialog opens
and shows a list of all the copied data.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 89

  Warning
• If you select the Copy Data operation, DataHub allows you to leave unresolved nodes
when copying data.
• If you select the Copy Data with Sync operation, you must map all nodes to maintain
the data hierarchy, or select the Exclude all unmapped nodes from DHLinks option to
ignore any unmapped nodes.

To copy data or create a DHLink from a Data Source within DataHub Explorer

1. From the Operation drop-down list in DataHub Explorer, do one of the following
• Select Copy Data to copy data only.
• Select Copy Data with Sync to copy data and create synchronization links.
2. Drag a node from any Data Source to a node within DataHub Explorer. Either the source or
target node must be a MagicDraw® node.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 90

 3. The Copy Data dialog opens, prompting you to choose either Individual or Group Type Mapping
mode. Choose a mode and map the source types to appropriate target types. Click OK.

 Tip
The following rules apply to the Copy Data with Sync operation:
• All nodes under the dragged source root node must be able to create the
synchronization links.
• A node cannot have more than one Sync relation with one Data Source. For example,
node a has a Sync relation with Data Source D1. Therefore, node a cannot create another
Sync relation within D1, but it can create a Sync relation with any node under Data
Source D2 or other Data Sources.
• You can drag a node whose child has a Sync relation. However, all the nodes under the
Sync node are locked in the Copy Data with Sync dialog and the existing Sync relations
are moved to a new parent node.
• You cannot move an object across the Formal Module in DOORS.
• You cannot change the type of the node that will be moved or has been moved, e.g.,
from a module to an object and vice versa.

To copy data from a CSV Data Source to MagicDraw Data Source

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 91

 1. From the Operation drop-down list in DataHub Explorer, do one of the following
• Select Copy Data to copy data only.
• Select Copy Data with Sync to copy data with synchronization.

2. Drag the nodes from the CSV Data Source to MagicDraw Data Source. A dialog appears
confirming you want to add the nodes recursively. Select one of the following
• If you want to copy the selected node with data hierarchy, select Yes.
• If you want to copy only the selected node without data hierarchy, select No.
3. The Copy Data dialog opens to allow you to choose Individual or Group Type Mapping mode.
Choose a mapping mode and map the source types to appropriate target types.

 Note
• Nesting is not possible for CSV data source, as CSV file has no data hierarchy.
• You cannot copy links (a MagicDraw® or a DOORS link) to a CSV Data Source since links
always have data hierarchy with their parent nodes.
• You cannot synchronize relations with a CSV Data Source if you change the attribute
synchronized with a CSV key field because DataHub uses the CSV key field to indicate the
synchronization target.

Copy Data with DHTrace operation

This DataHub operation is similar to Copy Data with Sync, but whereas synchronization relations are
either source to target, or target to source, or bidirectional, the direction of DHTrace is not important.
There is only a link relationship between the source and target nodes. When either of the nodes
changes, the DHTrace relationship is marked with a Suspect status and allows you to clear the DHTrace
and validate the Requirement.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 92

To Copy Data with DHTrace

1. From the Operation drop-down list in Cameo DataHub Explorer, select Copy Data with
DHTrace.

2. Drag some selected nodes from the Cameo DataHub Explorer panel to the Containment tree.

The Create DHTrace Summary dialog opens.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 93

 3. Make some changes to the nodes on any side, e.g., modifying a node or deleting a node.

 Information
DHTrace can detect a modified or deleted node.

4. Right-click the changed node on either side and select Check DHTrace Changes Recursively.
The DHTrace Summary dialog opens.

5. Select the checkboxes to the left of any Suspect relationships and click OK to clear the Suspect
DHTrace links.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 94

  Information
If you do not clear the suspect DHTrace links, they will have the Suspect status.

 Tip
Copy Data, Copy Data with Sync, and Copy Data with DHTrace all copy data along with links.
To skip copying links, hold CTRL while dragging the nodes. This operation ignores the links in
the application, e.g., DOORS 9.X Link, DOORS Next Generation Link, and MagicDraw Link.

Create Sync operation

The Create Sync operation is an addition to the list of Cameo DataHub operations. The Create Sync
operation will recreate synchronization (DHLinks) if you lose or delete the DHLinks. Before, in order to
recreate synchronization (DHLinks), if you lost or deleted the DHLinks you were required to copy the
data from the Cameo DataHub to the modeling tool(Cameo) using the Copy Data with Sync operation.
This new operation allows you to recreate synchronization(DHLinks) without replicating the data.

The same data source exists in the Cameo DataHub Explorer panel and the
Modelling tool without DHLinks
To create sync between existing data

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 95

 1. From the Operation list in the Cameo DataHub Explorer panel, select Create Sync.

2. Drag the parent data set from the Cameo DataHub Explorer panel and drop it over the identical
data set in the Containment tree.

3. The Create Sync Wizard will appear. Perform the Type/Attribute mapping as you would while
using the Copy Data with Sync operation (see page 82).

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 96

 4. Select the mapped type, then choose the Key attribute between them. The key attribute will be
used to match the values.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 97

 5. Once matching results are displayed, do one or several of the following:

 The matching result displays the matched attributes in green(Sync relation created) and
unmatched attributes in red(Sync relation not created).

• If there are key attributes that do not match (highlighted in red) and you want them to be
included, select the checkbox for the particular value and click Add Sync.
• If there are key attributes that match and you do not want them to be included, select the
checkbox for the particular value and click Remove Sync.
• If there are key attributes that do not match (highlighted in red)and you want them to be
excluded, select the checkbox for the particular value and click Exclude.
• Select Ignore all no sync source entities checkbox, if you want all nodes that did not
match to be ignored. The synchronization will discover them later.
• Select Exclude all no sync source entities checkbox, if you want all the nodes that did
not match to be marked as Excluded. The synchronization will no longer include them in
the operation.

6. Click Finish.

 Until every node is marked as synced or excluded, you cannot click Finish.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 98

 Once the procedure is finished, the newly created synchronization will be visible as shown in the
image below, denoted with the S icon.

Create DHTrace operation with OSLC links

On this page

• Create DHTrace operation (see page 100)

• Creating OSLC links through the Create DHTrace operation (see page 102)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 99

  Note
In addition to creating DHTrace, the Create DHTrace operation enables you to create OSLC
links instead of using the Create OSLC link operation in earlier versions of Cameo DataHub
19.0.

Create DHTrace operation

This DataHub operation does not copy data. It only creates a DHTrace link from a source to a target.
When the source has any changes, the DHTrace link becomes Suspect.

To create DHTrace

1. From the Operation drop-down list in Cameo DataHub Explorer, select Create DHTrace.

2. Drag any nodes from DataHub Explorer to the MagicDraw Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 100

 The Create DHTrace Summary dialog opens.

3. When you modify the source nodes, right-click one of them and select Check Changes > Check
DHTrace Changes or Check DHTrace Changes recursively. The DHTrace Summary dialog
appears showing the Suspect status of the DHTrace links.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 101

 4. Select the checkboxes of the data nodes you want to clear the Suspect status in the DHTrace
Summary dialog and click OK.

Creating OSLC links through the Create DHTrace operation

 Note
In the 19.0 and later versions, the Create OSLC link operation is not displayed and is used
through the Create DHTrace operation instead from the Operation drop-down list in Cameo
DataHub Explorer (for IBM® Rational® DOORS® Next Generation Data Source).

OSLC links can be created when you open an IBM® Rational® DOORS® Next Generation Data Source in
DataHub.

To create an OSLC link

1. From the Operation drop-down list in DataHub Explorer, select Create DHTrace.
2. From an IBM® Rational® DOORS® Next Generation Data Source, drag a node into the
MagicDraw® Containment area.
3. A shortcut menu prompts you to choose the type of link. Select one from the shortcut menu. The
link of the selected type will be created.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 102

 12 Figure OSLC Link types

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 103

 The newly created OSLC hyperlinks in the MagicDraw® Containment tree.

13 Properties of OSLC Link

The OSLC hyperlink's Properties.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 104

 The OSLC hyperlink is in the DH Links panel.
Related page

• Creating OSLC links (see page 181)

Property value conversion

On this page

• Converting rules from an Enumeration to another Enumeration (see page 106)

• Converting rules between source attribute values and target values as String (see page 107)

In addition to property-to-property mapping, you can apply a conversion rule to convert an original
property value to another value when importing or synchronizing the data. You can set the conversion
rule by clicking the Edit rule button at the end of each property mapping in the Cameo DataHub
Schema Map Manager dialog or DataHub operation dialogs.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 105

 The Edit rule button in the Cameo DataHub Schema Map Manager dialog to set
the conversion rules.

The Edit rule button in the Copy Data with Sync dialog to set the conversion
rules.
Converting Rule Editor has two converting rule schemes as follows

• Converting rules from an Enumeration to another Enumeration.

• Converting rules between source attribute values and target values as String.

Converting rules from an Enumeration to another Enumeration

The Converting Rule Editor dialog converts all the mapped Enumeration values on the left table and
converts the Enumeration values from the left table back to the right table and vice versa. In the first
table, the first column will list the Enumeration values of the source property, and the second column
automatically shows the values that match the values of the Elements to synchronize. In the right table,
the Enumeration values will be in relation to the selected mapping values in the left table.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 106

 Selecting Enumeration values for conversion in the Converting Rule Editor dialog.

 Important
If there is no matching value, you must manually correct all the mapping attribute values
shown in red.

Converting rules between source attribute values and target values as String
In the Converting Rule Editor dialog, the left table allows specifying the values of source attributes in
String to be converted to target values according to the selected conversion rules. The table on the
right allows the user to select the rules to convert the values of target attributes to source values.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 107

Selecting the rules to convert the values of source attributes to target values in the Converting Rule Editor
dialog.

 Tip
• To add another conversion rule, click .
• When setting all the conversion rules, you can use for left-to-right reflection or
for right-to-left reflection of the conversion rules for round-trip synchronization.

Using the >> button for left-to-right reflection of the conversion rules for round-trip synchronization.

 Important
In case of conversion conflicts, you need to manually correct all the mapping attribute values
shown in red.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 108

  Note
You must specify a conversion rule for the <ANY VALUE> source attribute to ensure that the
selected conversion rule applies to other unspecified values of source attributes.

The Converting Rule Editor dialog has the following conversion rules

• <CONVERT TO>
Synchronize the converted value if the source value matches the value in the From column.

• <DEFAULT>
Synchronize the original value if the source value matches the value in the From column.

• <IGNORED>
Do not perform any synchronization if the source value matches the value in the From column.

Copying Requirements into a modeling tool

DataHub allows you to copy Requirements from DOORS into UML diagrams, from DOORS Data Source
to the Containment area as Use Case diagrams, from DOORS or DOORS Next Generation to a modeling
tool with DHLinks, and copy Requirements using OSLC links.
Related pages

• Copying Requirements to a modeling tool as the SysML Requirement diagram (see page 109)
• Copying Requirements to a modeling tool as the Use Case diagram (see page 111)
• Copying Requirements to a modeling tool with DHLinks (see page 114)
• Copying Requirements to a modeling tool with OSLC links (see page 117)

Copying Requirements to a modeling tool as the SysML Requirement diagram

You can copy text-based Requirements and their associated Use Cases from DOORS or DOORS Next
Generation Data Sources by simply dragging the node from the DOORS Data Source to your modeling
tool's Containment tree.

This section deals with how to copy text-based Requirements from IBM® Rational® DOORS® into a UML
diagram.

To copy Requirements from DOORS Data Source to a modeling tool as the SysML Requirement diagram

1. Add a DOORS Data Source (see page 121)or DOORS Next Generation Data Source (see page 140)in
DataHub Explorer.
2. Select a node and drag it from DataHub Explorer to your modeling tool's Containment area.
3. Map the Formal Module to a package and the object to a base stereotype of the Requirement.
Click OK.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 109

 The Copy Data dialog in Group Type Mapping mode when copying Requirements from DOORS to the
modeling tool's Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 110

14 Result of copying SysML requirements diagram to MagicDraw

The dragged Requirement elements in the Requirement diagram as the result of copying.

Copying Requirements to a modeling tool as the Use Case diagram

This section deals with copying a Use Case diagram from a DOORS Data Source into your modeling
tool's Containment area.

To copy a Use Case from a DOORS Data Source to a modeling tool as the Use Case diagram

1. Add a DOORS Data Source (see page 121)or DOORS Next Generation Data Source (see page 140)in
DataHub Explorer.
2. Drag the selected node from DOORS Data Source to your modeling tool's Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 111

 3. Map the Formal Module to a Use Case diagram type and the object to a Use Case type. Click OK.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 112

 The Copy Data dialog in Group Type Mapping mode when copying Use Case elements from DOORS to the
modeling tool's Containment area.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 113

15 Result of copying Use Case Diagram to MagicDraw

The Use Case diagram after copying Requirements from DOORS to a modeling tool.

Copying Requirements to a modeling tool with DHLinks

To copy Requirements from DOORS or DOORS Next Generation Data Source to a modeling tool

1. From the Operation drop-down list in DataHub Explorer, select Copy Data with Sync.
2. Drag a data node in a DOORS or DOORS Next Generation Data Source from DataHub Explorer to
the modeling tool's Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 114

 3. The Copy Data with Sync dialog appears. From the Mapping Mode drop-down list, choose
Individual Type Mapping or Group Type Mapping.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 115

 4. After you finish all attribute mappings, click OK. The copying result is shown in the modeling
tool's Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 116

16 Result of copying SysML requirement with DHLink

Copying Requirements to a modeling tool with OSLC links

 Note
In the 19.0 and later versions, the Create OSLC link operation is not displayed and is used
through the Create DHTrace operation instead from the Operation drop-down list in Cameo
DataHub Explorer (for IBM® Rational® DOORS® Next Generation Data Source).

This version of DataHub now supports OSLC queries and links that you can create OSLC links through
the Create DHTrace operation (see page 99).

To copy Requirements using OSLC links

1. From the Operation drop-down list in DataHub Explorer, select Create DHTrace.

2. From an IBM® Rational® DOORS® Next Generation Data Source, drag a node into the modeling
tool's Containment area. A shortcut menu appears, prompting you to select the type of link.
Select one from the shortcut menu.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 117

The newly created OSLC hyperlink from copying the Requirement in the modeling tool's Containment tree.

Working with Data Sources

Before connecting a Data Source to a driver, you need to have the DataHub Explorer tab open in
MagicDraw®.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 118

To open DataHub Explorer

1. Start MagicDraw® and create a new project or open an existing one.

2. From the MagicDraw® main menu, click Tools > DataHub > DataHub Explorer. The DataHub
Explorer tab opens.

17 DataHub Explorer

Related pages

• Adding Data Sources for CSV (see page 119)

• Adding Data Sources for IBM Rational DOORS (see page 121)
• Adding Data Sources for IBM Rational DOORS Next Generation (see page 140)
• Adding Data Sources for OSLC Provider (see page 165)
• Adding Data Sources for ENOVIA Requirements (see page 165)
• Adding Data Sources for JAMA Connect - Technology preview (see page 168)

Adding Data Sources for CSV

To add a new CSV Data Source

1. On the DataHub Explorer toolbar, click the Add Data Source button .

The Add Data Source dialog opens.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 119

18 Adding a CSV Data Source to DataHub explorer

2. From the Driver drop-down list, select CSV.

3. Enter the CSV information in the following boxes explained in the table below

Field Function

File The CSV file to be added.

Key The name of the column header used as the ID of the node.

 Note
The Key field is mandatory if you have selected the Copy Data
with Sync operation from the Operation drop-down list in
DataHub Explorer.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 120

 Field Function

Label The name of the column header created as the name of the node.

 Note
If you leave the Label field blank, a running number will be
assigned for the name.

Separator Select a delimiter for the CSV file. The available delimiters are comma,
semi-colon, space, and slash.

Save option
If you select the check
box, DataHub makes changes to the CSV file when the CSV item is saved.

4. Click Create.

 Note
• A CSV file must contain the names of attributes in the first row and data in the other
rows.
• Once the CSV Data Source has been created, make sure the following conditions
• The order of the data in the tree view in DataHub Explorer is the same as that of
data in the CSV file.
• If you edit the data in the tree view in DataHub Explorer, you must click Save
to save the new data to the CSV file.
• If the data in the CSV file has been updated, you must click Reload

to update the tree view in DataHub Explorer.

• If a column name has been edited, or a new column has been added into the CSV
file, the CSV Data Source will be corrupted. You have to remove and add the CSV
Data Source again.

 Information
• Nodes under a particular driver in DataHub Explorer represent nodes in the application
that the driver represents.
• If a driver is correctly started, the name of the driver appears in the tree view in DataHub
Explorer. The driver connects to the data in each respective application.

Adding Data Sources for IBM Rational DOORS

 Prerequisite
To add the IBM® Rational® DOORS® data source, the properties file must be updated for JAVA
version 17 and above.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 121

 To update the properties file

1. Close the modeling tool.

2. Go to <install_root>\bin folder.
3. Open <modeling_tool_name>. properties file using any text editor.
4. At the end of the “JAVA_ARGS=” line, add any one of these three arguments:
• -Ddatahub.com_library\=VBS
• -Ddatahub.com_library\= VBS-DXL
• -Ddatahub.com_library\= COM4J
5. Save and close the file.
6. Relaunch the modeling tool after saving the file.

To add an IBM® Rational® DOORS® Data Source

1. On the DataHub Explorer toolbar, click the Add Data Source button.

2. From the Driver drop-down list, choose IBM® Rational® DOORS®.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 122

 3. Click Create

 Warning
Before adding an IBM® Rational® DOORS® Data Source, you must start the DOORS client on
your machine; otherwise, MagicDraw® generates an error dialog box.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 123

Creating DOORS module view Data Sources
In Rational DOORS, you can apply the filter that controls the display of particular information in the
content section. You can also save the information into views and deploy views to quickly switch data
perspectives. Additionally, DataHub supports the flat-hierarchy Module View you can create a Data
Source (without links) that represents objects of a particular view. You import all objects into
MagicDraw by dragging either the Module View Data Source or each node individually into MagicDraw
models to synchronize the Module View. When more objects are added to the view, DataHub can also
synchronize them into MagicDraw.

 Note
When creating the module view:
• All objects are shown in the flat hierarchy.
• Links with the module view Data Source is not supported.
• You can synchronize the module view into MagicDraw, but new elements from
MagicDraw will not be synchronized back to the module view Data Source. To
synchronize new elements from MagicDraw to the module view Data Source, you must
synchronize them from the original Data Source that represents that module.
• The data are available only when the view is visible, thus all DataHub operations for
module view Data Sources need the DOORS module with a particular view to be open at
all times.

To create a module view Data Source

1. Right-click a module in DataHub Explorer and select Create data source from View.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 124

 2. The Create data source from View dialog opens and lists all available views. From the View
drop-down list, select one of the views.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 125

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 126
 3. The module view Data Source of the selected view will be created.

DOORS Baseline Data Sources

You can access DOORS Baseline by adding a new Baseline Data Source.

To create the Baseline Data Source

1. Right-click any folder, project, or module you want to create the Baseline Data Source and select
Create data source from Baseline.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 127

 2. The Create data source from Baseline dialog opens and lists all Baseline versions grouped by
the Baseline set. Do one of the following:

• To create a Data Source with only the selected module, select a particular module version.
• To create a Data Source with all modules in the Baseline set, select a Baseline set version.

3. Select the Baseline that you want and click OK. You will get a new Data Source that contains the
modules with the specific version you have selected.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 128

It is possible that your data in DataHub (DHLink to MagicDraw) work with original DOORS Data Sources
or other Data Sources with different Baseline versions. If you also want the newly created Baseline Data
Sources to synchronize with those data, you can use the copying function to copy the DHLinks from
other DOORS Data Sources to the new Baseline Data Sources.

To copy the DHLink to a Baseline Data Source

1. Right-click any module in the Baseline Data Source and select Copy DHLink from other data
sources.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 129

 2. The Copy DHLink from other data source dialog opens. From the drop-down list, choose the
Data Source you want to copy the DHLink from.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 130

 3. Click OK. The DHLink will be copied to the new Baseline Data Source.

Customizing new node type for DOORS

To customize an Object in DOORS, you must specify attributes for each object individually. The
following outlines a few examples of how an object is specified.

• When you specify the Object Heading attribute value for an object, the object is recognized as a
Topic.
• When you specify the Object Text attribute value for an object, the object is recognized as a
Requirement.
A custom attribute can be used to identify a variety of requirement types in DOORS. However, that
could be difficult when you have multiple objects to customize.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 131

In Cameo DataHub, the Define Target Type option is provided while mapping to customize a module
or node. However, that could be difficult when it must be done for every module or when there are
multiple attributes to filter.

Using the JSON configuration, you can collectively customize DOORS objects to have multiple types. You
can even import the custom-created JSON configuration file in Cameo DataHub. With JSON
configuration you can write the configuration, as follows:

• (ObjectHeading=blank)+(ObjectType="Req") = Requirement
• (ObjectHeading=blank)+(ObjectType=”ExtReq”) = Extended Requirement
• (ObjectHeading=blank)+(ObjectType=”Physical”) = Physical Requirement
• (ObjectHeading not blank)+(ObjectType="Topic") = Topic

To import the configuration file

1. Right-click the parent node that you want to recursively apply the type configuration.
2. Select Customize Module/Object data type.
3. Select Import configuration.

 When the configuration file is imported, the DataHub tree will refresh.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 132

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 133
 Copy Data with Sync dialog showing only modules and object nodes

Copy Data with Sync dialog showing customized nodes after importing JSON configuration
Custom type definition JSON:

{
"custom_types" : [
<Type definition JSON>,
<Type definition JSON>
]
}

Type definition JSON:

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 134

 "type_name": "<type name>",
"doors_type": "Project | Module | Object",
"type_icon": "Project | Module | Object | <icon name in XML>",
"type_condition": <Value condition JSON>,
"init_doors_values": {
"<attr name>": "<attr value>",
"<attr name>": "<attr value>",
"<attr name>": "<attr value>"
}
}

Value condition JSON:

{
"value_condition": {
"attr_name": "<attr name>",
"condition": "= | != | > | >= | < | <= | contains | before | after | regex",
"attr_value": "<attr value>"
}
}
{
"all_match" : [
<Value condition JSON>,
<Value condition JSON>,
<Value condition JSON>
]
}
{
"any_match" : [
<Value condition JSON>,
<Value condition JSON>,
<Value condition JSON>
]
}
{
"not_match" : [
<Value condition JSON>,
<Value condition JSON>,
<Value condition JSON>
]
}

Sample configuration:

{
"custom_types": [
{
"type_name": "Topic",
"doors_type": "Object",

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 135

 "type_icon": "Object",
"type_condition": {
"all_match": [
{
"value_condition": {
"attr_name": "Object Heading",
"condition": "!=",
"attr_value": ""
},
"value_condition": {
"attr_name": "Object Type",
"condition": "=",
"attr_value": "Topic"
}
}
]
},
"init_doors_values": {
"Object Type": "Topic"
}
},
{
"type_name": "Requirement",
"doors_type": "Object",
"type_icon": "Object",
"type_condition": {
"all_match": [
{
"value_condition": {
"attr_name": "Object Heading",
"condition": "=",
"attr_value": ""
},
"value_condition": {
"attr_name": "Object Type",
"condition": "=",
"attr_value": "Req"
}
}
]
},
"init_doors_values": {
"Object Type": "Req"
}
},
{
"type_name": "Extended Requirement",
"doors_type": "Object",
"type_icon": "Object",
"type_condition": {
"all_match": [
{
"value_condition": {
"attr_name": "Object Heading",
"condition": "=",
"attr_value": ""

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 136

 },
"value_condition": {
"attr_name": "Object Type",
"condition": "=",
"attr_value": "ExtReq"
}
}
]
},
"init_doors_values": {
"Object Type": "ExtReq"
}
},
{
"type_name": "Physical Requirement",
"doors_type": "Object",
"type_icon": "Object",
"type_condition": {
"all_match": [
{
"value_condition": {
"attr_name": "Object Heading",
"condition": "=",
"attr_value": ""
},
"value_condition": {
"attr_name": "Object Type",
"condition": "=",
"attr_value": "Physical"
}
}
]
},
"init_doors_values": {
"Object Type": "Physical"
}
}
]
}

Customizing module and object labels in DataHub Explorer

Another capability of Cameo DataHub is designing labels of modules and objects for Rational DOORS
Data Sources that allows you to create labels from appending one or more property values and
additional text.

Instead of displaying the module names and object headings or object text in the tree, you can now
design the labels of modules and objects by using one or more properties’ values or adding some text.

 Note
This customization applies to the entire DOORS Data Source. You cannot customize the node’s
label for only some modules.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 137

To customize the node’s label

1. Right-click a DOORS Data Source and select Customize Module/Object label.

2. The Customize label dialog opens. Enter the name of the property that you want to display for
the module and object by placing the property name inside quotation marks. You can append
more properties or add some text, e.g., “Object Identifier”::”Object Heading”. Click OK.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 138

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 139
  Note
When you edit the node’s label, you must reload the tree in DataHub Explorer.

Adding Data Sources for IBM Rational DOORS Next Generation

There are two types of authentication when adding Data Sources for IBM Rational DOORS Next
Generation as follows

• Login authentication through the embedded browser

To support the secured environment with different authentications including single sign-on, the
embedded browser can be used to allow you to log on directly to the DNG login page so that
DataHub is able to make connections to a variety of secured servers.

• OAuth consumer key authentication

Before selecting one of the two authentication types, you must open the Add Data Source dialog first
and select the IBM Rational DOORS Next Generation driver.

To open the Add Data Source dialog and select IBM Rational DOORS Next Generation as the driver

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 140

 1. On the DataHub Explorer toolbar, click the Add Data Source button. The Add Data
Source dialog opens.

2. From the Driver drop-down list, select IBM Rational DOORS Next Generation.

To add an IBM Rational DOORS Next Generation Data Source using the Login authentication type
through the embedded browser

1. From the Authentication type options, select Login.

2. Specify Service Provider URL and Authentication URL.

 Note
If server addresses are copied and pasted into the Service Provider URL and
Authentication URL boxes, the addresses are automatically formatted as the format
examples shown below the boxes.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 141

 The Server information to be specified is explained in the table below
Server information Function Format

Service Provider URL Specifies a web application address to access https://<server>:<port>/rm/

DOORS. rootservices

Authentication URL Specifies an authentication address to log on https://<server>:<port>/jts/

(optional) DOORS. j_security_check

An authentication URL is required for

distributed authentication service.

3. Click Login with browser. The embedded browser opens the DNG Login page.

4. After logging on successfully, close the embedded browser. The newly created DOORS Next
Generation Data Source appears in the DataHub Explorer tab.

To add an IBM Rational DOORS Next Generation Data Source using the OAuth consumer key
authentication type

1. From the Authentication type options, select OAuth consumer key.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 142

 2. Specify Root Services URI, Consumer key, and Consumer secret.

The Server and OAuth information to be specified is explained in the table below
Server and OAuth information Function

Root Services URI Specifies a Root Services URI.

Consumer key Specifies a key provided by the administrator.

Consumer secret Specifies a secret provided by the administrator.

a
3. Click Create.

 Information
OAuth consumer key authentication when adding Data Sources for IBM Rational DOORS
Next Generation is similar to the process of adding Data Sources for an OSLC
Provider (see page 172).

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 143

Module artifacts of DOORS Next Generation
Normally, artifacts of DOORS Next Generation do not have hierarchy, and the module artifact is the
customized view of artifacts that can create structure of added or created artifacts. Since the module is
also an artifact, DataHub will show the module as a single node. However, with new support of the
DOORS Next Generation module, you can now open the module artifact to see a list of artifacts inside
as a separate tab.

 Note
Since artifacts in the module and their hierarchy do not reflect the original ones, DataHub will
treat artifacts in the module separately apart from the original artifacts out of the module.

To open the module in a new tab

• Right-click the module artifact and select Open module in new window. The module will be
open in another tab.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 144

 Using the Open module in new window command to open a DOORS Next Generation module artifact
in a new tab.

The selected Evaluation Suggestions DOORS Next Generation module artifact is open in a new tab.

When you work with the module next time, you can open the module through Alias Manager or by
clicking Open module in new window. In the module tab, you can perform all the same DataHub
operations as in DataHub Explorer.

Comment elements under Requirements of DOORS Next Generation Data

Source
In DOORS Next Generation, comments are together with Requirements as attributes. DataHub
captures comments by reading them as comment elements under Requirements. Therefore, you can
import and create mappings with any element types, including comment elements, under SysML
Requirements.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 145

 Comment elements in DOORS Next Generation under a Requirement.
To display a DOORS Next Generation comment element under a Requirement

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 146

 • Right-click a DOORS Next Generation Data Source and select Show comments.

The comment element(s) will be displayed under the Requirement(s) of the selected Data Source.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 147

 Comment elements are shown under the Requirement of the selected DOORS Next Generation Data
Source.

 Note
DataHub does not show the Requirements’ comment elements by default.

Creating a Stream and Baseline as a Data Source

A Component is a container in a project that you can use to organize artifacts. When connected with a
DOORS Next Generation Data Source, DataHub lists Components under each project. The main Data
Source tree still displays artifacts from default Components. You can also open additional Components
as another Data Source. Additionally, you can perform all DataHub operations, such as the main Data
Source, from the Component Data Source.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 148

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 149
 Components in DOORS Next Generation.

Components in DOORS Next Generation in Cameo DataHub Explorer.

You can now work with a Stream and Baseline by creating a new Data Source from components; thus,
DOORS Next Generation projects can be connected to a specific Stream and Baseline.

To create a Stream as a Data Source

• Right-click a Component element in DataHub Explorer and select Create Stream as Data
Source.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 150

 The Create Component/Stream as Data Source command.

 Note
• An Initial Stream is used when creating a Data Source for a Component without an
additional Stream.
• If the Component with Stream(s) other than the Initial Stream is selected, the Select
stream list in the Create Stream as Data Source dialog box will appear.

The Select stream list in the Create Stream as Data Source dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 151

 The created Stream Data Source.
To create a Baseline as a Data Source

• Right-click a Component element in DataHub Explorer and select Create Baseline as Data
Source.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 152

 The Create Baseline as Data Source command.

 Note

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 153

 • An Initial Baseline is used when creating a Data Source for a Component without an
additional Stream.
• If the Component with Baseline(s) other than the Initial Stream is selected, the Select
baseline list in the Create Baseline as Data Source dialog box will appear.

The Select baseline list in the Create Baseline as Data Source dialog box.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 154

 The created Baseline Data Source.

 Information
• Components on the CDH Explorer panel and DNG side are only visible and available to
use when the Configuration Management for selected projects is enabled.
• The Stream and Baseline Data Source name is represented in the format of <Project Area
name> | <Component name> | <Stream/Baseline name>.

Copying DHLinks across Stream or Baseline Data Sources

When you have synchronization with any existing Stream or Baseline, you can continue it with a new
stream or baseline. DataHub enables you to copy DHLinks from one Stream or Baseline Data Source to
another.

Selecting an existing DHLink in an Initial Stream or Baseline.

To copy an existing DHLink to another Stream or Baseline Data Source

1. Right-click an element in the target Stream or Baseline that DHLink(s) will be copied to and select
Copy DHLink from other data sources.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 155

 2. The Copy DHLink from other data sources dialog box opens. From the Select root element of
the DHLink list, select a Stream or baseline to copy DHLink(s) from. Click OK.

After links are copied from one data source to the other, both data sources will not contain
synchronized links. Data sources those links are copied from will be displayed with an x icon on the
components, indicating that it is not in synchronization with the model. The other data source the links
are copied to will be displayed with an s icon on the components, indicating that it is in synchronization
with the model.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 156

 The duplicated DHLink copied from the Initial Stream
It is possible to have both sources in synchronization by selecting the Include Link Recursively
command.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 157

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 158
 Inlcude DHLinks Recursively command

Both data sources in synchronization

 Note
• The selected element in the target Stream must be the root element of DHLink(s) in the
other Stream Data Source to perform the copying DHLink operation across Stream Data
Sources.
• When the Check for change command is initiated, you need to select which target stream
to check the model against.

Collection nodes in DOORS Next Generation

You can work with an artifact in a Collection via a new Collection tab that displays items of the
Collection artifact by using the Open collection in new window command.

To open a Collection artifact in a new tab

• Right-click a Collection element in DataHub Explorer and select Open collection in new
window.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 159

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 160
 The Open collection in new window command.

An open DOORS Next Generation Collection artifact tab in DataHub Explorer.

The new Collection artifact tab that shows items of the Collection artifact will open in DataHub Explorer.

 Note
• DataHub records the open Collection artifact tab as a new Alias tree, thus allowing you to
directly open the DOORS Next Generation Collection artifact tab by clicking Tools >
DataHub > Alias Manager and selecting the Collection from the list at the next time you
connect the DOORS Next Generation Data Source.
• All associated DHLinks created will be available only within the Collection artifact tab.

Configuration Management
On this page

• Working with Global Configuration (see page 162)

• Configuration Management effect on CDH Explorer Panel (see page 164)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 161

Configuration Management can be enabled once the project initiates, after which it cannot be disabled
later in DOORS Next Generation. When Configuration Management is not enabled for a project, only
the content of default project component is available in the Cameo DataHub Explorer Panel. When
configuration management is enabled, you can have more than one component in the project. Each
component could have multiple streams and baselines and can be used on Global Configurations. All
those objects once created and configured are available to work with in the Cameo DataHub Explorer
Panel.

Working with Global Configuration

The DOORS Next Generation connector now supports global configuration. When configuration
management is enabled in DOORS Next Generation, you can add all RM domain-related objects
identified on the selected global configuration to the Cameo DataHub Explorer panel as separate data
sources.

To create Global Configuration as a data source

1. Right click on the DOORS Next Generation data source and select Create GC Configuration as
Data Source

2. The Create GC Configuration as Data Source dialog box appears. From the Select GC project
list select the GC project. Select the GC component from the Select GC component list. Then
select the stream/baseline you want to work on from the Select GC stream/baseline list. The list
of available streams/baselines in the GC configuration are displayed below. Click Create to
create GC Configuration as Data Source.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 162

 3. After the GC configuration is created as a data source, it will be visible in the same Cameo
Datahub Explorer panel. Once you click on any stream/baseline, the GC configuration data
source will open in a new tab.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 163

 Configuration Management effect on CDH Explorer Panel

Enabling or disabling Configuration Management in DOORS Next Generation affects Cameo Datahub
Explorer Panel in the following ways:

• When Configuration management is not enabled, the content of the default component is
displayed under the project parent node.
• When Configuration Management is enabled, only the project's components are displayed under
the project parent node.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 164

 Configuration Management effect on CDH Explorer Panel

Adding Data Sources for OSLC Provider

See the Adding Data Sources for an OSLC Provider (see page 172) in the Working with OSLC features (see
page 171) section.

Adding Data Sources for ENOVIA Requirements

The ENOVIA Requirements connector, based on the Cameo DataHub framework, provides the data
copy and synchronization functionality between your model and the requirement management
application on the 3DEXPERIENCE platform. SAML is also supported for passing authorization
credentials to the platform. Furthermore, Cameo DataHub enhances the ENOVIA requirements
connection by applying a login with an embedded browser in place of a simple login form. As this is the
new authentication technique, this login method allows you to connect to both requirement data
sources deployed on Premises and Cloud.

To add an ENOVIA Requirements Data Source

1. Log in to the 3DEXPERIENCE platform.12

2. In the main menu, select 3DEXPERIENCE > ENOVIA Requirements.

12 https://docs.nomagic.com/display/MD2024xR1/Authentication+with+3DEXPERIENCE+platform

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 165

 3. In the specification selection dialog, from the list of all specifications available select one
specification and click Connect.

The one specification added is available in the new tab in the Cameo DataHub Explorer panel.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 166

To add more specifications one at a time

• Select the Add single requirement specification option from the ENOVIA data source shortcut
menu.

 The Specification Folder name is not displayed in the Cameo DataHub Explorer panel; only the
name of the Requirement Specification name is displayed. The Specification Folder name is
displayed in the specification selection dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 167

Related page

• Mapping source and target types to copy data to and from a modelling tool (see page 52)
• Authentication with 3DEXPERIENCE platform13

Adding Data Sources for JAMA Connect - Technology preview

• Supported features (see page 168)
• Features expected in next releases (see page 169)
• Limitations of Jama Connect (see page 169)
• Adding the Jama Connect data source (see page 169)

 Prerequisite- For on premise server only

Before adding the Jama Connect data source, you need to add the Jama Connect server
certificate. Make sure you have a valid certificate file before initiating the certificate addition
process. To learn more about adding server certificates, refer to Server Certificates14.

 You must add the server certificate before adding the Jama Connect data source,
otherwise it may cause your modeling tool to crash.

Supported features
1. You can authenticate with the aid of your User Name and password. Connection to both the
Cloud and On-premise versions of Jama Connect is possible.
2. When connected, you can see the list of all projects available in the Jama Connect web app.
3. You can drill down the structure of a project selected from the list of all projects available to you.
This feature is affected by limitation#1 (see page 169) and limitation#2 (see page 169).
4. The list of properties is available when you double-click the selected Jama Connect Project item
5. Currently, you can only synchronize the selected part of your project from Jama Connect to the
Cameo Model. This feature is affected by limitation#3 (see page 169).
6. The Scheme Map Manager is available to map, create, update, import, export, or set to be used
by default data mappings between the Cameo Model and the Jama Connect project.

13 https://docs.nomagic.com/display/MD2024xR1/Authentication+with+3DEXPERIENCE+platform
14 https://docs.nomagic.com/display/MD2024xR1/Server+Certificates

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 168

 7. When the synchronized part of the Jama Connect project is updated on the Jama Connect or
Cameo model side, the “Check for change” command is available to visually represent the
difference. “New”, “Moved”, “Delete” and other statuses are represented with different
background colors for visual clarity. It is also possible to see which exact property is updated, as
well as the new value.
8. Once the change is confirmed for either all or selected items, the Cameo model is updated.

Features expected in next releases

1. More Jama Connect item properties will be available for mappings.
2. Two-way synchronization from the Jama Connect to the modeling tool and vice versa will be
supported.
3. Images will be available to synchronize.
4. Diagram synchronization from the modeling tool to the Jama Connect project will be available.
5. Support for browser-based authentication will be available.
6. Diagram synchronization process from the command line UI will be available.
7. Data synchronization process from the command line will be available. The synchronization-
related settings will be stored on the configuration file.

Limitations of Jama Connect

1. The link representation in the Cameo Datahub tree is incorrect.
2. The sync icon is not shown for child elements.
3. The project structure is not copied correctly to the modeling tool.

Adding the Jama Connect data source

To add the Jama Connect data source

1. In the Cameo DataHub Explorer toolbar, click the Add Data Source.

2. In the Add Data Source dialog, select Jama Connect from the Driver drop-down list.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 169

 3. Enter the server URL and login information and click Create.

The data source is added in the Cameo DataHub Explorer panel.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 170

Working with OSLC features
The modeling tool can link and share data using Open Services for Lifecycle Collaboration (OSLC)
integration that allows the following

• The modeling environment to work smoothly in the IBM Jazz ecosystem.

• Linking different project lifecycle artifacts in different tools without additional plugins needed.
• Seeing information details of linked artifacts without switching between different tools.
The following chapters describe how the modeling tool works with OSLC:

• Adding Data Sources for an OSLC Provider (see page 172)

• OSLC Preview (see page 172)
• Linking model elements to OSLC resources (see page 177)
• Creating OSLC links (see page 181)
• Creating OSLC queries (see page 184)
• Copying OSLC query results to a modeling tool as SysML Requirements (see page 188)
• OSLC tutorial (see page 191)

Related page

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 171

 • Working with Data Sources (see page 118)

Adding Data Sources for an OSLC Provider

To add a Data Source for an OSLC Provider

1. Click on the DataHub Explorer toolbar. The Add Data Source dialog opens.
2. From the Driver drop-down list, select OSLC Provider.

3. Enter the Root Services URI, Consumer key, and Consumer secret (provided by your
administrator).
4. Click Create.
The new OSLC Provider is added to the DataHub Explorer tree.

OSLC Preview
Using DataHub Explorer, you can connect to the Data Sources, such as IBM® Rational® DOORS®,
IBM® Rational® DOORS Next Generation, or other OSLC Providers. DataHub Explorer lists the content
of the open Data Source.

The OSLC Preview tab in the Quick properties panel15 allows you to view the details of the OSLC
resource. The OSLC resource can be selected from DataHub Explorer, in the MagicDraw Containment
tree, and an OSLC link to the other node from the connected OSLC Data Source that links to an element
selected in the Model Browser.

15 https://docs.nomagic.com/display/MD2024xR1/Understanding+the+user+interface

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 172

To open the OSLC Preview tab

• From the main menu, select Window > OSLC Preview.

You can use OSLC preview to display the information of the selected node or the linked node in the
following ways:

• When you add an OSLC Data Source into DataHub Explorer, e.g., DOORS Next Generation, the
OSLC Preview tab can display the information of the selected node.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 173

 The details of the selected OSLC resource in Cameo DataHub Explorer are
displayed in the OSLC Preview tab.
• When you import data from an OSLC Data Source into the MagicDraw Containment tree, the
OSLC Preview tab can display the information of the related/linked node.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 174

 The details of the selected OSLC resource in the MagicDraw Containment tree
are displayed in the OSLC Preview tab.
• With an existing element in the model, you can also manually create an OSLC link to the other
node from the connected OSLC Data Source so that the OSLC Preview tab can display the
information of the linked node.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 175

 The detail of the resources that the OSLC link to are displayed in the OSLC
Preview tab.

When the Data Source in DataHub Explorer is closed, the preview of the selected element details is
not available. The OSLC Preview tab offers you a link to reconnect to the Data Source.

To reconnect to a Data Source

1. In the OSLC Preview tab, click the Connect to Data Source link.
2. In the login dialog, enter the User ID and Password.
3. Click Connect.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 176

 An example of the closed Data Source.

Linking model elements to OSLC resources

On this page

• Selecting an existing OSLC resource (see page 177)

• Creating a new OSLC resource (see page 179)

You can link your model elements to the OSLC resources through the hyperlinks.

There are two ways you can link a model element to an OSLC resource:

• Selecting an existing resource

• Creating a new resource

Selecting an existing OSLC resource

To link an element to an OSLC resource

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 177

 1. Do one of the following:
• In the Model Browser, select an element, open its Specification window16 and go to
Documentation / Hyperlinks property group. Click Add.
• On the diagram pane, select an element, click the Hyperlinks / Go To button at the
bottom left corner of the element shape. Select Add Hyperlink.
2. In the Edit Hyperlink dialog, open the OSLC Link tab.
3. From the OSLC link type drop-down list, select a link type.
4. Click the ... button. The Select OSLC Resource dialog opens.

5. In the Select OSLC Resource dialog, select the Choose Existing option.
6. Select an artifact and click OK.

16 https://docs.nomagic.com/display/MD2024xR1/Specification+window

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 178

 7. Click Close.
8. Close the Edit Hyperlink dialog.

Creating a new OSLC resource

To create a new OSLC resource

1. Do one of the following:

• In the Model Browser, select an element, open its Specification window17 and go
to Documentation / Hyperlinks property group. Click Add.
• On the diagram pane, select an element, click the Hyperlinks / Go To button at the bottom
left corner of the element shape. Select Add Hyperlink.
2. In the Edit Hyperlink dialog, open the OSLC Link tab.
3. From the OSLC link type drop-down list, select a link type.
4. Click the ... button. The Select OSLC Resource dialog opens.

17 https://docs.nomagic.com/display/MD2024xR1/Specification+window

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 179

 5. In the Select OSLC Resource dialog, select the Create New option.
6. Fill out the data for the new element.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 180

 7. Click OK.
8. Close the Edit Hyperlink dialog.
The created element is now linked to your selected model element.

Creating OSLC links

 Note
In the 19.0 and later versions, the Create OSLC link operation is not displayed and is used
through the Create DHTrace operation instead from the Operation drop-down list in Cameo
DataHub Explorer (for IBM® Rational® DOORS® Next Generation Data Source).

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 181

You can create OSLC links and queries from an IBM® Rational® DOORS® Next Generation Data
Source (see page 181) in DataHub by using the Create DHTrace operation from the Operation drop-
down list in Cameo DataHub Explorer.

To create an OSLC Link

1. Open an IBM® Rational® DOORS® Next Generation Data Source.

2. From the Operation drop-down list in DataHub Explorer, select Create DHTrace.

3. From the IBM® Rational® DOORS® Next Generation data source, drag a node into the
MagicDraw® Containment area.
4. There is a popup menu after dragging the node to the MagicDraw Containment area. Choose
one type of link from the list that you want to create.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 182

  Note
When you copy the Doors Next Generation (DNG) datasource's requirements from the
DataHub Explorer to the MagicDraw containment tree, the URI link is created automatically for
those requirements with the type “self”. This "self" type link is needed for previewing (see page
172), navigation, or other purposes.

The figures below show the newly created OSLC hyperlinks in the MagicDraw® Containment tree, OSLC
hyperlinks' properties, and an OSLC hyperlink in the DH Links panel respectively.

19 OSLC hyperlinks in MagicDraw containment area

The newly created OSLC hyperlinks in the MagicDraw® Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 183

20 Properties of OSLC Link

The OSLC hyperlink's properties.

An OSLC hyperlink in the DH Links panel.

Creating OSLC queries

There are two types of OSLC queries you can construct to query the DOORS® Next Generation artifacts
repository - simple or basic query and advanced query based on SQL or SPARQL. You can find the
details of OSLC queries and more examples of queries and their syntax on the OSLC Specification
website18.

To create and run a simple or basic OSLC query

1. Do one of the following

18 http://open-services.net/

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 184

 • On the main menu, click Tools > DataHub > Create OSLC Query from MagicDraw®.

• On the DataHub Explorer toolbar, click the Create OSLC Query button.
The OSLC Query Editor dialog opens.

21 OSLC Query editor window

2. Fill out the information that you want to create the query to search for.

3. Click . The results of the query, if any, appears below the Type text to search box.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 185

  Tip
• You can filter the search results of the query by using the Type text to search box.

• You can click to save the results in Alias Manager.

To create and run an advanced query

1. Do one of the following

• On the main menu, click Tools > DataHub > Create OSLC Query from MagicDraw®.

• On the DataHub Explorer toolbar, click the Create OSLC Query button.
The OSLC Query Editor dialog opens.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 186

22 The OSLC advanced Query Editor tab

2. Click the tab. In the Query String box, type your query using the simple or basic
query language, e.g., https://10.1.1.70:9443/rm/views?oslc.query=true or using the SPARQL query
language, e.g., https://host:port/bugs?oslc.select=dcterms:created,dcterms:creator{foaf:familyName}
&oslc.where=cm:severity="high".

3. Click . The results of the query, if any, appears below the Type text to search box.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 187

  Tip
• You can filter the search results of the query by using the Type text to search box.

• You can click to save the results in Alias Manager.

Copying OSLC query results to a modeling tool as SysML Requirements

To copy OSLC query results to a modeling tool as SysML Requirements, you must set up an
IBM® Rational® DOORS® Next Generation Data Source (see page 188) and query the Data Source using
OSLC query syntax. When you have the query results, you can copy them into your modeling tool as
SysML Requirements.

To copy OSLC query results to a modeling tool as SysML Requirements

1. Complete the steps of creating OSLC queries (see page 184).

2. From the OSLC query results, drag the matching query tree to the Containment tree of the
modeling tool.

2. The Copy Data dialog opens. From the target type list in the MagicDraw Side group,
choose Extended Requirement. Click OK.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 188

The result of the copy is shown in the MagicDraw Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 189

 The result of the copied OSLC query in the MagicDraw Containment tree.

 Information
OSLC Query Editor supports the Copy Data, Copy Data with DHTrace, and Create
DHTrace operations.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 190

 The Copy Data, Copy Data with DHTrace, and Create DHTrace operations are supported in the OSLC Query
Editor dialog.

OSLC tutorial
Cameo DataHub has the ability to use OSLC data from any OSLC-compliant Provider. It is now possible
to establish hyperlinks between model elements and elements provided by an OSLC Provider, as well
as having OSLC previews of remote elements from within a modeling tool environment.

The steps for establishing links between model elements and OSLC resources are shown below:

Steps to establish links between model elements and OSLC resources.

In the following pages, you will find step-by-step descriptions for linking model elements with OSLC
resources.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 191

Configuring software for OSLC integration

Software requirements
To link and share data using Open Services for Lifecycle Collaboration (OSLC) integration, ensure that
the following software requirements are met:

• The following software is installed on your machine:

a. Modeling tool with the Requirements plugin (e.g., MagicDraw + Requirements plugin,
Cameo Systems Modeler, Cameo Enterprise Architecture)
b. Cameo DataHub
• You have access to the following software on a server:
a. Teamwork Cloud
b. Cameo Collaborator for Teamwork Cloud
c. Doors Next Generation v6.0.3+ (DNG)

 Software versions
You must use the same version of a modeling tool and Cameo DataHub, and the same version
of Teamwork Cloud and Cameo Collaborator for Teamwork Cloud. For more information, see
the product compatibility page19.

Related pages

• Installing modeling tools (see page 192)

• Installing plugins (see page 192)
• Installing and configuring Teamwork Cloud (see page 192)
• Installing Cameo Collaborator for Teamwork Cloud (see page 192)

Business Use Case flow with DNG

This page outlines the steps to set up a Jazz platform. The abbreviations used in the description are
detailed below:

• TWC - Teamwork Cloud Server20

• DNG - Doors Next Generation
First, in Doors Next Generation, you must establish:

• Server-level friendship between TWC-DNG

• Project-level relationship between TWC-DNG

 OSLC root services URI pattern

OSLC root services document URI can be found using the following pattern - http(s)://
TWC_IP:PORT/oslc/rootservices. For more information, see OSLC API21.

You must also publish the project as an OSLC resource in Cameo Collaborator for Teamwork Cloud22.

19 https://www.nomagic.com/support/compatibility
20 https://docs.nomagic.com/display/TWCloud2024xR1/Teamwork+Cloud+Documentation
21 https://docs.nomagic.com/display/TWCloud2024xR1/OSLC+API
22 https://docs.nomagic.com/display/CC4TWC2024xR1/Publishing+an+OSLC+resource

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 192

After establishing server and project-level relationships, open your modeling tool (MagicDraw23, Cameo
Systems Modeler24, or Cameo Enterprise Architecture25), and perform the following steps:

1. Add requirements (import or sync) from DNG through DataHub as described at Adding IBM
Rational DOORS Next Generation Data Sources (see page 140).
2. Copy requirements from DataHub to your model as described at Copy Data with Sync
operations (see page 82).

 The adding of requirements has been enhanced during OSLC consumer implementation
in version 19.0. Users are able to see the DNG requirement’s OSLC Previews in the OSLC
Preview (see page 172) tab of a modeling tool.

3. After importing requirement(s) to your model under the Copy Data with Sync mode, create
«Satisfy» relationships to/from those requirements to system model elements.

 Currently, only SysML’s «Satisfy» is fully covered under this Business Case.
4. Synchronize changes back to the DNG side, as described at Synchronizing Requirements (see page
227).
5. After the synchronization, the changed requirement’s properties will be reflected on the DNG’s
requirements artifact. Additionally, an OSLC backlink is created in DNG. Thus, if the «Satisfy»
relationship between a Block <B> and Requirement <R> was established in your model, a
backlink relationship «Satisfied by» is created in DNG, pointing to the Block’s <B> identifier, which
in OSLC’s context is an http URL.

 Currently, only SysML’s «Satisfy» is fully covered under this Business Case.
6. The figure below depicts an OSLC UI preview of the linked Block <B>.(this is not a CC preview!):

23 https://docs.nomagic.com/display/MD2024xR1
24 https://docs.nomagic.com/display/CSM2024xR1
25 https://docs.nomagic.com/display/CEA2024xR1

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 193

Creating links between elements
DataHub links can create relationships between elements. The relationship determines how the
elements react when one of the elements changes. You can use the MagicDraw shortcut menu to
navigate to DHLinks.

To navigate to DHLinks from the MagicDraw shortcut menu

• Right-click a node in the MagicDraw Containment tree. Select Go To > DHLinks.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 194

23 MagicDraw Containment Tree context menu to navigate to DHLinks

Creating DHTrace links

There are two types of links supported by DataHub: DHLinks and DHTrace links. You can choose to
copy data with DHLinks, with DHTrace links, or without any links.

To create a DHTrace link

1. From the Operations drop-down list, select the Create DHTrace option.
2. Drag a node, e.g., a DOORS or CSV Data Source, to the MagicDraw Containment tree.
3. The Create DHTrace Summary dialog box opens to confirm the DHTrace link has been created.

24 DHTrace Summary dialog - shows when you create a DHTrace

The DHTrace links appear on the DH Links panel.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 195

25 The newly created DHTrace in the DHLinks panel

DHTrace links on the DH Links panel.

 Note
Nodes that contain DHTrace links are indicated with small half-green squares. In the following
figure, the DHTrace links are created between CSV Data Source nodes and MagicDraw
elements. The links are indicated with small half-green squares in Cameo DataHub Explorer
and the MagicDraw Containment tree.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 196

 CSV Data Source nodes with DHTrace links to MagicDraw elements are indicated with small half-green
squares in Cameo DataHub Explorer and the MagicDraw Containment tree.

Related page

• Copy Data with Sync (see page 195)

Removing DHLinks
DataHub provides two options to remove the DHLink of a node as follows

• Remove only a DHLink or DHTrace of the selected node.

• Remove all DHLinks or DHTraces recursively in the node hierarchy.

To remove a DHLink or DHTrace (recursively), do one of the following

• Right-click an item in DataHub Explorer and select Remove DHLinks.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 197

 • Right-click a DHLink in the DH Links panel and select Remove DHLink.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 198

26 Removing DHLink in the Cameo DataHub DHLink Panel

• Right-click a Traced or Suspect link in the DH Links panel and click Remove DHTrace.

27 Remove DHTrace option from DHLinks Panel

• Right-click a node in the MagicDraw Containment tree and select DataHub Actions > Remove
DHLinks.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 199

Cleanup for unused DHLinks
When used for a period of time, DataHub may contain DHLinks left over in the database where the
referencing objects are no longer available. This can happen when nodes were manually removed
without using the synchronization mechanism. Therefore, DataHub has another capability to detect
unused DHLinks and remove them. You can also use this function when you want to split part of a
synchronized model as a used project.

To remove all unused DHLink

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 200

 • On the main menu, click Tools > DataHub > Remove non-use DHLink.

DataHub will detect the DHLinks that are not being used by any elements in the project, and the
summary will be shown before you are confirmed to delete them.

Opening selected Requirements in DataHub Explorer or other applications

To open a selected Requirement in DataHub Explorer or other applications

• Right-click the Requirement node you want to open and select DataHub Actions > Select
Related Element. You can choose DataHub Explorer to open the Requirement node in
DataHub Explorer, or you can choose Application to open the Requirement node in the other
application that the node is associated with, e.g., DOORS.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 201

Requirement Mapping
You can do simple schema mappings or define target types from attribute value mappings between
sources and targets in Cameo DataHub by using Schema Map Manager. This section also describes
exporting, importing, and deleting schema mappings by using the Schema Map Manager dialog.
Related pages

• Mapping with Schema Map Manager (see page 202)

• Schema mapping modes (see page 204)
• Exporting schema maps (see page 209)
• Importing schema maps (see page 212)
• Deleting schema maps (see page 212)

Mapping with Schema Map Manager

The Schema Map Manager dialog allows you to see all attributes of both sources and targets. It
automates data matching and mapping so that you can integrate data on both sides and make them
identical.

To open the Schema Map Manager dialog in MagicDraw®

1. From the main menu, click Tools > DataHub > Schema Map Manager. The Cameo
DataHub Schema Map Manager dialog opens.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 202

 2. Expand the nodes to see the types that have already been mapped.

You can also select a schema map template in the Schema Map Manager dialog by expanding each
Data Source. DataHub also allows you to view schema maps used by particular relations. You can right-
click an item in the table and select View Schema Map to open the View Schema Map dialog from that
schema map.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 203

 The View Schema Map dialog showing schema maps used by particular
relations.

Schema mapping modes

You can map nodes by doing either of the following

• Using simple Schema Mapping (see page 204)

• Define Target Type from Attribute Value dialog and mapping (see page 208)

Simple schema mapping

You can do simple schema mapping and update existing schema maps in the Schema Map
Manager dialog between data in the source schema and the target schema. You can also define a target
type from the attribute value mappings by selecting the Define Target Type from Attribute Value
option.

If your previous mapping mode is Define Target Type from Attribute Value mapping, it is set as the
default mapping automatically. You can also change the default mapping back to a simple mapping so
that you can use the simple mapping to copy data when the Define Target Type from Attribute Value
mapping mode is not selected.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 204

To specify a default mapping

1. Open the Cameo DataHub Schema Map Manager (see page 202) dialog.

2. Select a source type that you want to edit its mapping. The default target type appears in the
Target Type section.
3. Select a target type in the Target Type section that you want to specify as the default one.
4. Click Set as Default. The selected target type is now the default mapping, and the button
changes to Remove Default.

To remove a default mapping

1. Open the Cameo DataHub Schema Map Manager (see page 202) dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 205

 2. Select a source type that you want to edit its mapping. The default target type appears in the
Target Type section.
3. Select a default target type in the Target Type section that you want to remove.
4. Click Remove Default. The selected target type is no longer the default mapping, and the button
changes to Set as Default.

To edit a schema mapping

1. Open the Cameo DataHub Schema Map Manager (see page 202) dialog.
2. Select a source type that you want to edit its mapping. The default target type appears in the
Target Type section.
3. Select a target type in the Target Type section that you want to edit. The Select Attribute to Sync
list shows the list of default attributes mapping.
4. Click Edit to enable editing mode.
5. Change the attributes mapping, and then click Save.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 206

  Note
If the edited schema mapping affects any elements in the current project, the Edit Schema Map
Confirmation dialog opens. Click Yes to confirm that you want to edit the schema, No to cancel
the editing, or Details to see the details of all affected nodes.

28 Edit Schema Map Confirmation Dialog

The Edit Schema Map Confirmation dialog.

 Information

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 207

 After DataHub saves an edited schema map, it will be effective when you perform data
synchronization next time.

Related page

• Mapping with Schema Map Manager (see page 202)

Define Target Type from Attribute Value dialog and mapping

The Define Target Type from Attribute Value mapping is another copying and synchronization capability
in Cameo DataHub. This capability helps to locate or find a node type in the target so that you can map
a node type from the source to the target. You can update the target types and attribute values in the
Define Target Type from the Attribute Value dialog.

The following video shows the data mapping based on the attribute value in action:

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=VKWR9lMCGHs

Enabling the Define Target Type from Attribute Value Mapping

If you previously mapped a schema and copy data using the Define Target Type from Attribute Value
mapping mode, you will automatically have the same mode open as the default mapping mode the
next time you open the Cameo DataHub Schema Map Manager (see page 202) dialog. Therefore, the
Export Schema Map Wizard dialog no longer opens the next time you copy data. If you do not want to
map in this mode, you can click Deactivate to disable the Define Target Type from Attribute Value
mapping mode in the Cameo DataHub Schema Map Manager dialog.

To disable the Define Target Type from Attribute Value mapping mode

1. Open the Cameo DataHub Schema Map Manager dialog.

2. Select a source type that you want to map. The default target type appears in the Target Type
section.
3. Select a target type in the Target Type section. The Select Attribute to Sync list shows the list of
default attributes mapping.
4. Click Deactivate to disable the Define Target Type from Attribute Value mapping mode. After
you click Deactivate, the button changes to Activate.

To enable the Define Target Type from Attribute Value mapping mode

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 208

 1. Open the Cameo DataHub Schema Map Manager dialog.
2. Select a source type that you want to map.
3. Select a target type in the Target Type section. The Select Attribute to Sync list shows the list of
default attributes mapping.
4. Click Activate to enable the Define Target Type from Attribute Value mapping mode. After you
click Activate the button changes to Deactivate.

Updating the Define Target from Attribute Value Mapping

You can add, remove, or change the priority of a target type to high or low priority. You can update the
attribute mappings through the Define Target Type from Attribute Value dialog.

To update the defined target type from attribute value mapping

1. Open the Cameo DataHub Schema Map Manager dialog.

2. Select a source type that you want to map.
3. Select a target type in the Target Type section. The Select Attribute to Sync list shows the list of
default attributes mapping.
4. Click Edit and update the mapping values.

5. Click Save.

Exporting schema maps

When you have copied some data with types and attributes mappings, DataHub stores the mappings
between the types and attributes. If you set them as the default mappings, DataHub maps the source
node with the target node automatically the next time you copy data or create DHLinks. You can edit
those mappings later in the Schema Map Manager (see page 202) dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 209

With the Export Schema Map Wizard, you can export an existing schema map to an XML file by
selecting a particular schema map from a Data Source in the selected driver.

To export a schema map

1. Open the Cameo DataHub Schema Map Manager (see page 202) dialog and click .
The Export Schema Map Wizard dialog opens. In the Source Driver and Target Driver
sections, select the source and target Data Source that you want to export its mapping. Click

2. Select the data types that you want to export their mappings and click .

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 210

 3. Type the name and description of the schema map.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 211

 4. Click to select a location to save the file.

5. Click to export the schema map.

Importing schema maps

You can import a schema map that is in the XML format to DataHub.

To import a saved schema map

1. Open the Cameo DataHub Schema Map Manage (see page 202)r26 dialog and click .

2. Select a schema file to import and click .

Deleting schema maps

If a schema map is referenced by a DHLink, it cannot be deleted. You can delete only schema maps that
are not referenced by any DHLinks. Deleting a Define Target Type from Attribute Value mapped
schema deletes all defined target types. If you want to delete only some values of the schema, you can

26 https://docs.nomagic.com/display/CDH190/Mapping+with+Schema+Map+Manager

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 212

delete them in the Define Target Type from Attribute Value (see page 208) dialog.

To delete an existing schema map

1. Open the Cameo DataHub Schema Map Manager (see page 202) dialog.
2. Select a source type that you want to edit its mapping. The default target type appears in the
Target Type section.
3. Click Delete. A confirmation dialog box to confirm the deletion opens. Click Yes.

 Note
If you delete a schema map that is currently in use, an error message opens, showing that one
or more relations are using the deleted schema map. Therefore, you must delete the relations
first, and then delete the schema map.

Working with the DHLink summary and generating reports

You can review DHLinks and make filtering options in terms of selected driver, direction of
synchronization, sources and targets, types, status, and DHTrace, to display all interconnected relations
through the DHLink summary dialog (see page 214). With the shortcut menu in the DHLink Summary
dialog, you can remove DHLinks, change synchronization directions, or select nodes from DataHub

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 213

Explorer/Alias Explorer or in their original applications. You can also save the DHLink summary as an
HTML report and open it in browsers.
Related pages

• DHLink Summary (see page 214)

• Directions of DHLinks (see page 216)
• DHLink Summary dialog shortcut menu (see page 217)
• Saving the DHLink summary as reports (see page 219)
• Adding another attribute into the report template (see page 220)

DHLink Summary
If you have many DHLinks to review, you can select DHLink Summary from the DataHub menu to
open the Cameo DataHub DHLink Summary dialog and view all types of links. In the DHLink
Summary dialog, you can filter the relations that you want to view and adjust the display. You can also
remove or update a relation, or clear the status.

There are two filter options: No DHLink and DHLink. The No DHLink option filters all elements that
have no DHLink element in the DataHub, and the DHLink option filters all elements that contain
DHLink synchronization.

The functions of the DHLink Summary dialog are as follows

• Provides the options to extract specific relation types and customize their scope from a project
and to preview them.
• Saves the extracted relation types in the customized scope to be included in a generated report.
• Generates DHLink Summary reports in HTML containing the selected relation types.

To open the DHLink Summary dialog

1. On the MagicDraw main menu, click Tools > DataHub > DHLink Summary.
2. The DHLink Summary dialog opens. The Filter Options pane on the left-hand side allows you to
choose what type of relations you want to see. You can select one of the following:
• No DHLink to display independent standalone elements and nodes without any DHLink.
• DHLink to display the relation between elements. The state of the DHLink could be
Synchronized, Orphan, Pending Delete, Pending Update, or Excluded.
• DHTrace to display the state of a DHTrace. If the DHTrace is changed on either side, it
becomes Suspect. If there is no change, its state remains as Traced.
3. Select any check boxes that represents the driver and Data Source to open them in the DHLink
summary.

4. Click . The DHLink summary displays on the right-hand side of the dialog.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 214

29 DHLink Summary of DataHub

The table below provides the description of each column in the DHLink Summary dialog.

Column Description

Source The name of the element or node in a selected driver that has a DHLink.

The sources are ordered according to their Data Sources.

Direction The direction of synchronization between two elements.

Target The name of the element that has a DHLink with another element in the Source column.

Type The type of the element. This is usually a node or a link.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 215

 Column Description

DHLink Type The type of DHLink between the Source and Target.

Status The status of the DHLink that can be Synchronized, Pending Update, Pending Delete,
Excluded, or Orphan.

DHTrace To include a summary of the DHTrace links - Suspect or traced.

Directions of DHLinks
Besides showing types of DHLinks and the source and type elements that have DHLinks, the DHLink
Summary (see page 214) dialog displays the direction of the DHLink with an arrow. The arrow describes
the direction of synchronization graphically, either unidirectional or bidirectional.

Sy Type Sync status Description

mb
ol

Two-way sync Synchronized Data synchronization can be performed on both sides, which
are source or target with the Synchronized status.

One-way Sync Synchronized Selecting this synchronization mode allows the Data Source
from from the node with a DHLink in the other driver picks up
MagicDraw changes from the MagicDraw Data Source.

One-way Sync Synchronized Selecting this synchronization mode allows the MagicDraw Data
to MagicDraw Source to pick up changes from the node with a DHLink in the
other driver.

All Pending The relation status is PendingUpdate, PendingDelete, or

Update/ Orphan, and the data are updated from the source to the
Pending target.
Delete

All Pending The relation status is PendingUpdate, PendingDelete, or

Update/ Orphan, and the data will be updated from the target to the
Pending source.
Delete

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 216

 Sy Type Sync status Description
mb
ol

--- All Excluded This symbol is used for a DHLink relation that has been
-- excluded and has a virtual relation.

DHLink Summary dialog shortcut menu

To open the shortcut menu in the DHLink Summary (see page 214) dialog

• In the DHLink Summary dialog, right-click a value in the element. The shortcut menu opens.

The shortcut menu of the root data node in the DHLink Summary dialog.

The shortcut menu of a data node in the DHLink Summary dialog.

To open the shortcut menu in the DH Links panel

• In the DH Links panel, right-click a Data Source in the element. The shortcut menu opens.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 217

 The shortcut menu of the synchronized DHLink in the DH Links panel.

The shortcut menu of DHTrace in the DH Links panel.

The table below summarizes the shortcut menu items in the DHLink Summary dialog and DH Links
panel.

Menu Function

Change Direction (only for the root Changes the direction of synchronization: Sync from MagicDraw
element) and Sync to MagicDraw.

Remove DHLink Removes the selected DHLink from both of the associated nodes.

Remove DHTrace Removes the selected DHTrace from both of the associated nodes.

Clear Suspect DHTrace Clears the Suspect status from both of the associated nodes.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 218

 Menu Function

Select MagicDraw project name Selects the element in the MagicDraw Containment tree.
node in Application

Select MagicDraw project name Selects the MagicDraw node in DataHub/Alias Explorer.
node in DataHub Explorer

Select Data Source name node in Selects the node in the original application, e.g., the node originally
Application from DOORS will be opened in the DOORS client application.

Select Data Source name node in Selects the node from other Data Sources, e.g., DOORS, in DataHub/
DataHub Explorer Alias Explorer.

Discard Update (only for the Synchronizes the node by discarding the DHLink.
Pending Update status)

Exclude Node (not for the root Excludes the node from being included for synchronization.
element)

Include Node Includes the selected node and its child nodes for the
synchronization.

Update Pending DHLink (only for Synchronizes the node by updating the pending DHLink.
the Pending Update status)

View Schema Map Opens the Schema Map Manager (see page 202) dialog.

Saving the DHLink summary as reports

After you view a DHLink summary, you can click to save the summary view. The report is
saved in the HTML format so that you can open it in a web browser, e.g., Chrome or Firefox.

To save a DHLink summary as a report

1. In the Filter Options pane on the left-hand side of the DHLink Summary (see page 214)
dialog, choose type of relations you want to see in the DHLink summary.
2. Do one of the following to save the report

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 219

 • Click to view the DHLink summary and click to save the DHLink
summary as a report.

• Click to save the DHLink summary as a report without viewing the items in
the DHLink summary.

 Tip

If you want to save a large amount of data in the report more quickly, click .

Adding another attribute into the report template

DataHub uses report template code from its report template to create the layout and detail of a
DHLink Summary report. You can find the report template file in
<install_root>\plugins\com.nomagic.datahub.magicdraw\data\templates\relation.html. You can edit the
report template file with any text editors to add more information to the report template. In this
scenario, you want to add another attribute to the report template.

30 The Inside of a Report Template

The report template code inside the report template file and the construction of
the report layout and data script.
To add another attribute to the report template and generate a DHLink Summary report

1. Open the template file located in

<install_root>\plugins\com.nomagic.datahub.magicdraw\data\templates\relation.html. with any text
editors.
2. Type the following code in the highlighted area of the report template code fragment to add
more attributes to the report template file. For example, if you want to add the Created Thru
attributes into the report template file to include them in the DHLink Summary report, you must
replace <Attribute name> with Created Thru.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 220

 The code for adding another attribute in the report template file

<br/
>$DataHubReportEngine.decorateHTMLTag($row.sourceElement.entity.getAttributeVal
ue("<Attribute name>"))

 Note
The name of the attribute you want to add in the report template file must be the same
as the one that appears in the Cameo DataHub Properties tab.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 221

 The attribute name, e.g., Created Thru, in the DataHub Properties tab must match the <Attribute
name> in the report template code.

3. Save the template file.

4. Open the DHLink Summary (see page 214) dialog in MagicDraw to generate the DHLink Summary
report. (see page 220)

A DHLink Summary report generated from the report template before adding
another attribute.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 222

 A DHLink Summary report generated from the report template after adding
another attribute.

Using DataHub in Teamwork Cloud environment

DataHub supports local and remote connections. A local project is a project that is stored on your
machine. When you connect to Teamwork Cloud, other users can remotely see the project you are
working on through Teamwork Cloud. Multiple users can collaborate and work on the same project
concurrently and the DHLink map will be stored along with the project on Teamwork Cloud. This allows
all users to see other users’ changes in their work.

In addition to local and remote connections, DataHub also provides functionality that allows several
users to access and work on the same project including DataHub relations at the same time. This
functionality is available for projects that are stored on Teamwork Cloud.

Related page

• Data Sources on Teamwork Cloud (see page 223)

Data Sources on Teamwork Cloud

Data Sources on Teamwork Cloud are projects accessible to all users who have credentials to the
network. Therefore, Teamwork Cloud Data Sources are actually projects stored in Teamwork Cloud. A
Teamwork Cloud project may be accessible to more than one client.
Related page

• Teamwork Cloud projects (see page 223)

Teamwork Cloud projects

A Teamwork Cloud project creates Data Sources on the repository server and can be identified as the
same project for different clients. Since the DHLink mapping detail is stored along with the project
details on the Teamwork Cloud, all clients can see and receive changes from one another, in case they
update the changes before committing.

The project is treated in compliance with the Teamwork Cloud rules. For instance, you need to log on to
Teamwork Cloud first before checking out the items that you need to work on. For more information
about Teamwork Cloud, see Collaborative modeling27 in the MagicDraw® User Guide.

Updating Teamwork Cloud projects

A DataHub Data Source in a Teamwork Cloud project, which is opened through Teamwork Cloud, is
accessible to multiple clients. When multiple clients are working at the same time on the same
Teamwork Cloud project that contains DHLink, DataHub shows the project and the number of clients

27 https://docs.nomagic.com/display/MD2024xR1/Collaborative+modeling

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 223

that are using it under a single Data Source in DataHub Explorer. The Data Source shows the project
currently open on each client’s machine.

You can add a Teamwork Cloud Data Source to DataHub Explorer. You can work on the Data Source
and save the changes. Other users can also do the same things you do to the same project. Therefore,
the project in the Teamwork Cloud Data Source may contain different sets of data as a result of
multiple updates.

As long as all clients update the changes before committing, no conflicts occur because the DHLink map
is stored on Teamwork Cloud along with all the project details.

 Information
For more details about setting Teamwork Cloud in MagicDraw®, see the MagicDraw® User
Guide.

To log in to Teamwork Cloud

1. On the MagicDraw® main menu, click Collaborate > Login. The Login dialog opens.

2. Enter all the server connection parameters.

3. Click OK.

The table below explains each connection parameter.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 224

 Parameter Name Function

User name Specifies a user name to connect to Teamwork Cloud.

Password Specifies a password to connect to Teamwork Cloud.

Server name Specifies a Teamwork Cloud server name or IP Address.

Auto Login to Server Logs on to Teamwork Cloud automatically when MagicDraw® starts.

Use Secured Connection (SSL) Turns on SSL encryption for data transfer.

OK Confirms the connection parameters and logs in to Teamwork Cloud.

Cancel Cancels the login process.

Help Opens the Help dialog.

To open a Teamwork Cloud project

1. On the MagicDraw® main menu, click Collaborate > Open Server Project. The Open Server
Project dialog opens.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 225

 2. Select a particular project and click Open. MagicDraw® opens the selected project.

 Important
• All users must connect to Teamwork Cloud using the same host address (IP address or
machine name).
• DataHub handles the items in Data Sources in compliance with Teamwork Cloud rules.

Synchronization
DataHub helps you to Synchronize the data between the modeler and the data source. Synchronization
can be done one way or two ways. You can also check the changes made on either the modeler side or
the data source side.

To learn more about synchronization, refer to:

• How synchronization works (see page 227)

• Synchronizing Requirements (see page 227)
• One-way synchronization (see page 243)
• Synchronize buttons and commands (see page 246)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 226

 • Defining a target type from an attribute value (see page 251)
• Synchronizing changes in data hierarchy (see page 255)
• Excluding some nodes when copying data (see page 255)
• Checking for node changes before synchronizing data (see page 257)
• Synchronizing nodes (see page 259)
• Synchronizing changes in schema mapping (see page 259)
• Splitting part of a synchronized model as a used project (see page 261)
• Copying data with custom types and properties (see page 264)

How synchronization works

DataHub synchronization capability is a core feature of the DataHub. Synchronization is primarily used
for keeping track of changes. This synchronization feature allows you to track different types of node
changes, to update or remove DHLinks from the Synchronize button on either side of the MagicDraw
Containment area or DataHub Explorer, to synchronize Data Sources with other collaboration tools,
and to choose to synchronize single, grouped, or entire Data Source.

The following videos show the data synchronization and the data links in action:

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=O3LijuCItEM

Sorry, the widget is not supported in this export.

But you can reach it using the following URL:

https://www.youtube.com/watch?v=gKiXaQK7Wf8

Related pages

Synchronizing Requirements
Data synchronization is the process of sending all changes in the attribute values including a list of
deleted items from a source to target data. Either the source or target must be a MagicDraw® node.

Data synchronization allows you to maintain the consistency of data across nodes in different Data
sources and applications. During synchronization, all types of changes in a Data Source or application
are stored in the DHLink map along with the project in its repository.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 227

In addition to the Synchronize command on the DataHub Actions menu, DataHub provides the
synchronization option through the DataHub main menu and the Synchronize buttons in the
Containment tree and DataHub Explorer.

Data synchronization can be categorized into two functional types: Data Source synchronization and
node synchronization.

Data Source synchronization is to synchronize all items in the entire Data Source that have DHLinks in a
current project in an application.

Node Synchronization allows you to synchronize a specific node using either of the following mode:

• Synchronize Node
• Synchronize Node Recursively.

 Note
DataHub ignores all excluded nodes in the Sync relations during data synchronization.

You can perform synchronization on the selected node by clicking the Synchronize button on the
DataHub Explorer toolbar.

31 Synchronizing a Data Source using the Synchronize button in DataHub explorer

The Synchronize button on the DataHub Explorer toolbar.

Alternatively, you can perform synchronization from the MagicDraw® main menu by
clicking Tools > DataHub > Synchronize updates to Data Source.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 228

 Performing synchronization from the MagicDraw main menu.
Related pages

• Data Source synchronization (see page 229)

• Node synchronization (see page 231)
• Tracking changes on Conflict Dashboard (see page 233)
• Directions of synchronization (see page 238)
• Synchronizing DOORS External Links (see page 239)

Data Source synchronization

You can synchronize a Data Source by selecting it and clicking either the Synchronize button on the
DataHub Explorer toolbar or by choosing the Synchronize menu item from the shortcut menu.

To synchronize an entire Data Source, do one of the following

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 229

 • Select a Data Source in the DataHub Explorer tab and click the Synchronize button on the
DataHub Explorer toolbar.

• Right-click a Data Source and select Synchronize > Synchronize Node or Synchronize Node
Recursively to synchronize all items that have DHLinks within the selected Data Source.

 Information
The Synchronize button in DataHub Explorer is enabled only when you select a node or a Data
Source.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 230

Node synchronization
Node synchronization allows you to select a particular node that you want to synchronize. There are
two ways to synchronize a node: Synchronize Node and Synchronize Node Recursively.

When you select a node and right-click to select Synchronize Node, DataHub synchronizes only the
selected node. The Synchronize Node Recursively command synchronizes a selected node and its
child nodes.

After selecting a node that you want to synchronize, choose one of the following procedures to
complete the node synchronization.

To synchronize data with node synchronization on the MagicDraw® main menu

1. Select a node to synchronize. On the main menu, click Tools > DataHub > Actions >
Synchronize > Synchronize Node or Synchronize Node Recursively.

To synchronize data with node synchronization on the MagicDraw side through the shortcut menu

• In the MagicDraw Containment tree, right-click a node to synchronize and select DataHub
Actions > Synchronize > Synchronize Node or Synchronize Node Recursively.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 231

To synchronize data with node synchronization on the DataHub Explorer side through the shortcut
menu

• In DataHub Explorer, right-click a node to synchronize and click Synchronize > Synchronize
Node or Synchronize Node Recursively.

When the Data Synchronization Confirmation dialog box opens, click OK to proceed.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 232

32 Data Synchronization Confirmation Dialog

The Data Synchronization Confirmation dialog box.

 Note
• The Synchronize menu item can detect changes in a node that has DHLink information,
and synchronization can begin from the source node or the target node to the other
node.
• Both Check DHLink Changes and Synchronize commands can detect newly created
nodes including the children only at one-level depth. For example, if you want to
synchronize a node that you have synchronized before, but it has another new node
created at the depth lower than one level after the last synchronization, that new node
and its child nodes will not be detected.
• Both Check DHLink Changes Recursively and Synchronize Node
Recursively commands can detect only newly created nodes and their children.
• Synchronization process and Check DHLink Changes process do not involve DHTrace.

Tracking changes on Conflict Dashboard

The Conflict Dashboard lists all the nodes that have been changed, moved, deleted, or excluded. A
simple color scheme enables you to differentiate their modified conditions.

 Information
The Check DHLink Changes Recursively command checks for changes in both the selected
node and its child nodes.

To access the Conflict Dashboard from a node in the MagicDraw Containment tree

• In the MagicDraw Containment tree, right-click a node and choose DataHub Actions > Check
Changes > Check DHLink Changes or Check DHLink Changes Recursively.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 233

To access the Conflict Dashboard from a node in DataHub Explorer Panel

• In DataHub Explorer Panel, right-click a node and select Check Changes > Check DHLink
Changes or Check DHLink Changes Recursively.

When you Check DHLink Changes or Check DHLink Changes Recursively, the Conflict Dashboard
dialog appears if there are any changes.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 234

 The Conflict Dashboard dialog.

 If there are no changes, the following dialog appears.

The Conflict Dashboard is comprised of the following components

• Source and Target data trees

• Display drop-down list
• Properties panel
• Node changes in colors
• Synchronize and close buttons
The Display drop-down list, Properties panel, and node changes in colors are explained below.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 235

Display drop-down lists
The Display drop-down lists allow you to filter the pending synchronizations according to the type of
modifications.

The Display drop-down list in the Conflict Dashboard.

Properties panel
The Conflict Dashboard Properties panel shows the properties and attributes of the source and target
nodes.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 236

 The Conflict Dashboard Properties panel.

Node changes in colors

The Conflict Dashboard displays node changes in colors explained in the following table.

Change Color Meaning

type

New Green Refers to a new node in the scope or a deleted node at the end of a one-way
Entity synchronization (re-create).

Modified Blue Refers to a modified node.

Moved Yellow Refers to a moved node.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 237

 Deleted Pink Refers to a deleted node or a new node at the end of a one-way sync (force-
delete).

Out of Red Refers to a node that is no longer within the scope of the root node.
Scope Lettering

Excluded Gray Refers to a node that has been excluded from synchronization.
Lettering

 Information
If there is more than one Data Source connected, the dialog prompting you to choose a
target Data Source to check for node changes appears.

Directions of synchronization
The synchronization direction allows you to choose the direction from which the changes are sent.
There are three directions of data synchronization in the dialog of the selected DataHub Explorer
operation as follows

•
Synchronizations are in both directions.

•
The third-party Data Source is always synchronized to the MagicDraw Data Source.
•
The MagicDraw Data Source is always synchronized to the third-party Data Source.
Related page

• Operations in DataHub Explorer (see page 77)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 238

Synchronizing DOORS External Links
After Requirements are synchronized from DOORS, they can have Relationships, e.g., Satisfy or Derive,
with other elements in the model. In this version, DataHub can synchronize these Relationships back to
DOORS and create External Links that help display and navigate to those relationships with related
model elements.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 239

DataHub synchronizes Relationships back to DOORS and creates External Links
to display and navigate to those relationships.

The External Link in DOORS displaying the Relationship and navigating to the
related model element.

To synchronize a related element in the model with Requirements in DOORS as an External Link

1. Right-click the module or parent node of Requirements and select Create/Update External
Links to the Satisfying elements. The External Link will be created in the Requirements that
contain Relationships in DOORS.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 240

  Note
If you have selected the root node of the Sync Scope, the Create/Update External Links
to the Satisfying elements operation will recursively detect the changes. Otherwise,
only the selected node will be checked.

2. The Updating External Links dialog opens to show the synchronizing actions of the selected
module or parent node of Requirements. Click Synchronize to proceed with the actions.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 241

 3. The Create/Update External Links Summary dialog opens to show the summary of External
Links that have been created or updated. Click Close to complete the External Link
synchronization.

 Note

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 242

 External Links will be created with or deleted from Requirements in DOORS according to
the Relationships in the model.

One-way synchronization
Synchronization updates data from one end of a DHLink to another. With one-way synchronization,
data flows in only one direction. With two-way synchronization, you can either synchronize data from
the source to the target or from the target to the source. Nodes that are selected for one-way
synchronization have the icons.

Nodes selected for one-way synchronization in the MagicDraw Containment

tree.
One-way synchronization updates data only in the direction specified in the Sync Direction option. For
example, if the synchronization direction is from the source to the target, DataHub will synchronize
updates that come from the source to the target data.

If there are no changes in the source data, a message saying there are no changes to synchronize
appears.

To copy data with one-way synchronization

1. Drag a source node to a target node. The Copy Data with Sync dialog appears, depending on
what you have selected in the Operation drop-down list. From the Mapping Mode drop-down
list, choose either Group Type Mapping or Individual Type Mapping.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 243

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 244
 2. From the Sync Direction option, choose the direction of data synchronization. The selected
synchronization direction will apply to all nodes to copy. Available options for data
synchronization direction are Two-way Sync, One-way Sync to MagicDraw, and One-way Sync
from MagicDraw.
3. Complete the schema mapping28 then click OK to start copying data.

To apply one-way or two-way synchronization direction to any existing relations

1. Double-click the root node of the DHLink hierarchy or right-click it and select Properties. The
Cameo DataHub DHLink panel opens.
2. Right-click the relation that you want to apply one-way synchronization to and select Change
Direction.
3. Select the synchronization direction that you want. The selected synchronization direction will
recursively apply to all child nodes.

28 https://docs.nomagic.com/display/CDH2024xR1/
Mapping+source+and+target+types+to+copy+data+to+and+from+a+modeling+tool

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 245

Synchronize buttons and commands
DataHub has Synchronize buttons and commands in different locations to perform different functions
as follows

• On top of the MagicDraw Containment tree

When you click this Synchronize button, all nodes from MagicDraw are synchronized. A
single node without children nodes can be synchronized, while a node containing children nodes
can be synchronized recursively.

33 Synchronize button on MagicDraw containment Tree

The Synchronize button on top of the MagicDraw Containment tree.

• On top of DataHub Explorer.
When you click this Synchronize button, all nodes in the Data Source of the selected node
in DataHub Explorer are synchronized.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 246

 34 Sync button on DataHub Explorer toolbar
The Synchronize button on top of DataHub Explorer.
• From the MagicDraw main menu
Clicking Tools > DataHub > Synchronize updates to Data Source performs the same function
as clicking the Synchronize button on top of the MagicDraw Containment Tree. All nodes
from MagicDraw are synchronized. A single node without children nodes can be synchronized,
while a node containing children nodes can be synchronized recursively.

The Synchronize updates to the Data Source command from the MagicDraw
main menu.
• From the MagicDraw shortcut menu
When you right-click a node and select DataHub Actions > Synchronize > Synchronize Node or
Synchronize Node Recursively, the selected node is synchronized or recursively synchronized.
You can also Update Pending DHLinks, Update Pending DHLinks Recursively, Clear Suspect
DHTraces, Clear Suspect DHTraces Recursively, Remove DHLinks, Remove DHLinks
recursively, Remove DHTrace, and Remove DHTrace recursively.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 247

 The Synchronize command from the MagicDraw shortcut menu.

The Update DHLinks command from the MagicDraw shortcut menu.

The Remove DHLinks command from the MagicDraw shortcut menu.

• From the DataHub shortcut menu

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 248

 The Datahub shortcut menu is for Synchronize Node or Synchronize Node Recursively that
the selected node is synchronized or recursively synchronized, Update DHLinks, and Remove
DHLinks. You can also Update Pending DHLinks, Update Pending DHLinks Recursively, Clear
Suspect DHTraces, Clear Suspect DHTraces Recursively, Remove DHLinks, Remove DHLinks
recursively, Remove DHTrace, and Remove DHTrace recursively.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 249

 The Synchronize command from the DataHub shortcut menu.

The Update DHLinks command from the DataHub shortcut menu.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 250

 The Remove DHLinks command from the DataHub shortcut menu.

Defining a target type from an attribute value

The functionality of synchronization has been additionally simplified with the use of the Define Target
Type from Attribute Value option. The synchronization does not limit only to a simple type-to type-
mapping and attribute-to-attribute mapping but also a target node type can be defined dynamically
according to a specified attribute value.

To copy data and define a target node type from an attribute value

1. From the Operation drop-down list in DataHub Explorer, select one of the DataHub operations to
copy data. The Copy Data with Sync dialog (depending on the operation you have selected)
opens.
2. From the Mapping Mode option, select Group Type Mapping.

3. Select a source node type to start mapping.

4. Select the Define Target Type from Attribute Value check box.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 251

 5. From the Attribute drop-down list, choose an attribute to define a target node type.
6. Specify the attribute value to do the mapping.

 Information
• If the attribute is Enumeration, you can select a value from the Value drop-down
list for each attribute.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 252

 • If the attribute is a simple data type, you can type any expected value in the Value
box.

7. From the target type box on the right-hand side of the source type box, choose a target node
type for that value.
8. Continue mapping the attributes.

9. If you have more values for mapping, click to enter more values for mapping.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 253

 10. Repeat Steps 5 to 9 to map each attribute value.
11. When you finish mapping each attribute value, click OK to start copying.

 Note
• The functionality to map between Attribute value and Target type is available only in
Group Type Mapping.
• At least 2 values must be identified for mapping.
• You can edit or deactivate the mapping in the Schema Map Manager (see page 202) dialog.

Related page

• Mapping with Schema Map Manager (see page 202)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 254

Synchronizing changes in data hierarchy
The functionality of DHLink has been enhanced. The DHLink map is now stored along with the project
so you can avoid conflicts in multi-user scenarios. The synchronization does not only limit for updating
attribute values but also updating data hierarchy. When nodes are moved within the scope,
synchronization also affects the changes in the data hierarchy next time you synchronize the data.

Excluding some nodes when copying data

The Copy Data with Sync operation has been enhanced. It no longer requires you to map the whole
set of data before copying data. With the Copy Data with Sync operation, DataHub can exclude data
types that you do not map when you select as the target type and select the Exclude
all unmapped nodes from DHLinks check box, and these nodes will not be copied. Alternatively,
DataHub allows you to create the schema mapping for the selected nodes as Exclude by selecting the
target type. You can also include the portion of data that has been excluded later.

To exclude a portion of data while copying with DHLink

1. From the Operation drop-down list in DataHub Explorer, select Copy Data with Sync. The Copy
Data with Sync dialog opens.
2. Map the data types that you need to copy29.
3. Exclude nodes from being copied by doing one of the following

• Selecting the target type and the Exclude all unmapped nodes from
DHLinks check box.

29 https://docs.nomagic.com/display/CDH2024xR1/
Mapping+source+and+target+types+to+copy+data+to+and+from+a+modeling+tool

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 255

 • Selecting the target type.

4. Click OK to start copying the data. The copied data are indicated with the symbols, and the
data which is not copied are indicated with the symbols.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 256

To include previously excluded data into a scope set

1. Double-click a node marked with a symbol. The DH Links panel appears.

2. Right-click the relation table and select Include Node.

 Information
When you synchronize data next time, DataHub will recognize it as a newly added node to the
target side.

Checking for node changes before synchronizing data

DataHub allows you to check for updates or changes without synchronizing data. You can do this by
selecting the Check Changes on the DataHub shortcut menu. You can check updates in either the
target node or the target node and its hierarchy.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 257

To check for changes in a target node

1. Right-click a target node.

2. Select Check Changes and then select one of the options.

 Information
The Check Changes command also checks for changes in the hierarchy of the node that has
DHLinks.

To check for changes in a target node and its hierarchy

1. Right-click a target node.

2. Select Check Changes > Check DHLink Changes Recursively.

 Note
• The Check DHLink Changes Recursively command is enabled only when the selected
node has hierarchy.
• You can check the Pending Delete and Suspect DHTrace links status by selecting the
Data Source of deleted node(s) and choose Check Changes.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 258

Synchronizing nodes
To synchronize any nodes in the Conflict Dashboard dialog

1. Select any check boxes of Data Sources on either of the sides. The selected side will be the
master Data Source, and the other side will pick up the changes from the selected side.

 Note
A single node can be only synchronized from either the source to the target or the target
to the source. However, multiple nodes can have different synchronization directions,
e.g., one node can be synchronized from the source to the target, and another node can
be synchronized from the target to the source.

2. Click Synchronize.
Related Pages

• Tracking changes on Conflict Dashboard (see page 233)

Synchronizing changes in schema mapping

You can also synchronize updates on a schema map when you perform the data synchronization. If you
change a schema map, synchronization applies the changes in the schema map to the affected nodes.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 259

 The Schema Map Manager for synchronizing schema mapping.

 Note
After you update the schema map, the Edit Schema Map Confirmation dialog opens to notify
that you must synchronize the data again to synchronize the changes to the affected nodes.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 260

 35 Confirmation to Synchronize when a Schema Map is Changed
The Edit Schema Map Confirmation dialog.

Splitting part of a synchronized model as a used project

When the synchronized data are quite large, and you want to cut part of them into another separate
project, you can export both model data and DataHub database that include the synchronization
information to the new project.

To split part of a synchronized model as a used project

1. Select the DataHub_Data_<project> element. Copy and paste it into the same location under
the Model element in the Containment tree. You will get DataHub_Data_<project>1.

2. On the main menu, click File > Export To > Project Usage. The Export Packages to New
Project dialog appears. Select the Package you want to export and choose
DataHub_Data_<project>1.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 261

 3. Type a new project file name and click Save. You will see the selected data are saved to the new
project file.

4. On the main menu, click Tools > DataHub > Remove non-use DHLink. The confirmation dialog
appears. Select Yes.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 262

 The DHLinks for the elements that were exported to the used project will be removed from
DataHub_Data of the main project.

 Note
• When you export the used project, the full DataHub_Data will be copied.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 263

 • Since the Remove non-use DHLink operation affects only the main project, you need to
run this operation with the used project too. To remove the non-use DHLinks (the links
that belong to the main project) from the used project, you must open the used project
and select the Remove non-use DHlink command.

Copying data with custom types and properties

Elements in the source and the target data normally contain different sets of attributes. To have
matching attributes when copying data across tools, you need to prepare custom attributes for the
target types before copying data so that new custom attributes are available during data copying.

To prepare custom attributes for Requirement elements in MagicDraw®

1. Create a new Stereotype, e.g., <<doors_attr>>.

2. Add properties to <<doors_attr>>, e.g., Custom1 and Custom2. These properties are custom
attributes.
3. Create a Requirement element.
4. Right-click the created Requirement element and select Stereotype.
5. Search for <<doors_attr>> and select the stereotype. The custom data type is now ready for
DataHub. This data type is available for you to select in the Copy Data dialog.

When you select this data type as the target type, the custom attributes, Custom1 and Custom2, are
available.

Schema Mapping
DataHub is capable of synchronizing data in either one-way or two-way direction that you can apply to
other relations, showing updates or changes through checking DHLinks and DHTrace prior to
synchronizing data, excluding some nodes when copying data, providing synchronized changes in data
hierarchy and in schema mapping, arranging nodes into the group type mapping to complete mapping
faster, and dynamically defining target types from attributes' values before copying data.
Related pages

• Mapping modes (see page 264)

• Working with Schema Map Manager (see page 266)
• UI components of Schema Map Manager (see page 267)
• Exporting a schema map as a new template (see page 268)

Mapping modes
You can copy data from the MagicDraw Containment tree to DataHub Explorer or vice versa, or
within DataHub Explorer by dragging the source item to the target item. Therefore, you need to have a
Data Type and a Schema Map. If default Data Type or auto Schema Map is not found in the system,
Cameo DataHub asks you to do the mapping.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 264

DataHub provides two types of schema mapping modes: Individual Type Mapping and Group Type
Mapping as the default mapping mode, and the selected operation from DataHub Explorer is displayed
as the name of the dialog, e.g., Copy Data dialog. You can also change the default setting through the
Cameo DataHub Options dialog, including changing the default mapping mode.

The Mapping Mode drop-down list in the Copy Data with Sync dialog.

If you have mapped a schema with the option, DataHub saves this
mode automatically and use it as the default mapping mode. You can still change the default mapping
mode through the Copy data dialog.

DataHub also provides a default Schema Map template for mapping data. In the Schema Map
Manager (see page 35) dialog, you can find the default Schema Map template under the
IBM® Rational® DOORS® driver side.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 265

When you select a Schema Map template for mapping, DataHub uses the selected template again next
time you copy the same Data Type, if the copied data match the default Schema Map template. For
example, if you copy a node from a DOORS Data Source to MagicDraw®, DataHub automatically selects
a SysML Requirement node as the target type next time you copy data to the MagicDraw® driver. You
can also change the default Schema Map template in the Schema Map Manager dialog.

Working with Schema Map Manager

When copying data, schema maps are used for mapping source types to target types and also mapping
source attributes to target attributes. Schema Map Manager allows you to view schema maps
available in the system, edit a schema map, import a new schema map, or copy the current schema
map.

To open Schema Map Manager

• From the MagicDraw® main menu, click Tools > DataHub > Schema Map Manager. The
Schema Map Manager dialog opens.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 266

UI components of Schema Map Manager

The Schema Map Manager dialog.

The following UI components in Schema Map Manager are explained in the following table

UI component Function

Source Type All the source types from all Data Sources currently in the system.

Target Type All the target types from all Data Sources currently in the system.

Set as Default Sets the current schema configuration as the default one. After clicking, the button changes
to Remove Default. Clicking Remove Default removes the schema configuration from the
selected source and target types.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 267

 UI component Function

Activate (or Activates or deactivates the selected Define Target Type from Attribute Value (see page
Deactivate) 208)schema.

 Note
Activate and Deactivate UI components apply to only the Define Target Type
from Attribute Value mapping option.

Delete Deletes the current schema configuration.

Migrate Migrates the required scheme map to the present schema map.

Edit Edits a schema map.

Save Saves the editing of a schema map.

Cancel Cancels the editing of a schema map.

Import Browses a schema map file to import.

Export Opens the Export Schema Map Wizard (see page 209) dialog to guide you through exporting the
current schema to a file on your file system.

Close Closes the Schema Map Manager dialog.

Exporting a schema map as a new template

To export a schema map as a new template

1. On the main menu, click Tools > DataHub > Schema Map Manager. The Schema Map Manager
dialog opens. There are some properties with pre-mappings.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 268

 2. Click Export. The Export Schema Map Wizard appears.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 269

 3. Select the source and target driver of the map and click Next.
4. Do one of the following:

• If any maps are not attribute-defined, select the box(es) in front of the maps and click the
selected map to choose the type object, e.g., DOORS, to change it to a generic type. Click
Next.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 270

 • If any maps are attribute-defined, select all the box(es) in front of the maps that contain
defined attributes and click the selected map to choose the type object, e.g., DOORS, to
change it to a generic type. Click Next.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 271

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 272
 5. Name the schema and the exported file. Click Finish.

To import a schema map

1. On the main menu, click Tools > DataHub > Schema Map Manager. The Schema Map
Manager dialog opens.
2. Click Import and choose the schema map file. The template will be updated with the new
mapping.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 273

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 274
 The updated template with the new mapping and without defined attributes.

The updated template with the new attribute-defined mapping.

Additional DataHub features

In this section, you will learn more about Alias Manager to deal with aliases in DataHub, DHLink panel
for identification of changes in each data node, Schema Map Manager and its user interface
components to edit or deactivate the mappings, and the database clean-up operation for unused
reference removal in projects from modeling tools.
Related pages

• HTML images, RTF, and OLE support (see page 276)

• Working with custom IP Classification attributes (see page 281)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 275

HTML images, RTF, and OLE support
Cameo DataHub supports HTML image tags as attached files, text style in rich-text files (RTF), and image
and other objects (such as Embedded Excel spreadsheet and Words files) in object linking and
embedding (OLE).

To enable HTML image support from a data source in a project as an attached file

1. On the main menu, click Options > Environment. The Environment Options dialog opens.
2. In the left pane, select Cameo DataHub. Under the General group, set the Save HTML images
from the data source in the project as attached files option to true, as shown below:

3. Click OK to close the Environment Options dialog.

To enable HTML image support from a project in ENOVIA Requirements

1. Open for editing the <modeling_tool_install_dir>\bin\<modeling_tool>.properties file.

2. In the file, find the JAVA_ARGS line and add the -Ddatahub.mdp.image.converttoBase64=true
argument as one of its values.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 276

 3. Save the file and restart the modeling tool.

To enable RTF text support

• Right-click the DOORS Data Source and select Enable RTF for text support, shown below:

To enable RTF and OLE support for text style and image

1. Right-click the DOORS Data Source and select Enable RTF for text support.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 277

 2. Right-click the DOORS Data Source again and select Enable RTF for OLEs support.

RTF and OLE command Function

Enable RTF for text support Allows support of text styles in RTF when copying data from DOORS to
MagicDraw.

Disable RTF for text support Suspends RTF and OLE support.

(available after selecting Enable RTF

for text support)

Enable RTF for OLEs support Copies text styles and images as OLE objects from DOORS to
MagicDraw.
(available after selecting Enable RTF
for text support)
 Note
This function may take longer to complete the copying
process, depending on the amount of data.

If you selected only Enable RTF for text support, but did not select Enable RTF for OLEs support after
right-clicking the DOORS Data Source for the second time, copying elements (e.g., Requirements) from
DOORS to MagicDraw will include only text styles (e.g., bold, italic, underline, strikethrough, superscript,
and subscript). However, any image in the data will not be copied.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 278

 Text styles in RTF is copied from DOORS to MagicDraw when enabling RTF for
text support.

Image in RTF is not copied from DOORS to MagicDraw when selecting only the
Enable RTF for text support command.
If you selected Enable RTF for text support and then select Enable RTF for OLEs support after right-
clicking the DOORS Data Source for the second time, copying elements (e.g., Requirements) from
DOORS to MagicDraw will include both text styles and image as an OLE object.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 279

 RTF text styles and image as an OLE object are copied from DOORS to
MagicDraw.

Image as OLE object is copied from DOORS to MagicDraw as an AttachedFile

element under the copied element in the Containment tree.

 Note
Due to the different compatibility of image types between MagicDraw and DOORS, image types
are converted during synchronization between the tools.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 280

 • Synchronizing to MagicDraw: Image is converted to PNG.
• Synchronizing to DOORS: Image is converted to BMP.

 Note
• Enabling RTF and OLE support affects all child modules under the DOORS Data Source. If
you want to disable RTF and OLE support, right-click the DOORS Data Source and select
Disable RTF for text support.
• A DOORS object that contains a WMF image is set as read-only to avoid conversion to
BMP, which will result in the loss of functionality for the vector image.
• A DOORS object that contains any other OLE object besides an image is set as read-only
because DataHub does not support OLE objects.
• In most cases, the OLE content (e.g., embedded Excel table or Word) is converted to an
image and synchronized to MagicDraw.

Working with custom IP Classification attributes

If you use IP Classification Editor30 on the 3DEXPERIENCE platform to manage libraries and classes, you
can view and work with these custom IP classification attributes in the modeling tool as well. Cameo
DataHub allows you to choose whether the attributes are displayed or hidden and use them for
mapping and synchronization.

To view custom added attributes through IP classification

• Right-click on the ENVOIA REQS data source and select Show IP classification attribute

30 https://dsua.dsone.3ds.com/R2023x/English/?show=Lbc3DDashUserMap/lbc3ddash-c-ov.htm

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 281

After you click on the Show IP Classification attribute command, the data source will be reloaded and
the list of custom added attributes will be visible in the properties tab.

To view the properties tab

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 282

 • Right click on the data source and select Properties

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 283

 • A new tab will display the properties of the selected data source.

To hide the custom added attributes through IP classification

• Right-click on the ENVOIA REQS data source and select Hide IP classification attribute

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 284

Glossary
On this page

• Alias (see page 286)

• Artifact (see page 286)
• Bidirectional (see page 286)
• Data (see page 286)
• DataHub operations (see page 286)
• DataHub tree (see page 287)
• Data Source (see page 287)
• DHTrace (see page 287)
• Driver (see page 288)
• Excluded (see page 288)
• Global ID (see page 288)
• HP Application Lifecycle Management (HP ALM) (see page 288)
• Item (see page 288)
• Item type (see page 288)
• Link (see page 289)
• Mapping mode (see page 289)
• Module (see page 289)
• Node (see page 289)
• Orphan (see page 289)
• OSLC (see page 289)
• OSLC link (see page 290)
• OSLC query (see page 290)
• PendingDelete (see page 290)
• PendingUpdate (see page 290)
• Recursively (see page 290)

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 285

 • Relationship (see page 290)
• Requirements traceability (see page 290)
• Schema map (see page 291)
• Status (see page 291)
• Synchronized (see page 291)
• Sync relation (see page 291)
• System model (see page 292)
• Unidirectional (see page 292)

Alias
Alias is a name that is assigned to a node in the DataHub Explorer tree or MagicDraw® Containment
area tree. This node can then be accessed or removed via the Alias Manager (see page 31) dialog.

Artifact
An artifact is a kind of tangible by-products produced during software development. Some artifacts,
e.g., Use Cases, Class diagrams, and other Unified Modeling Language (UML) models, and requirements
and design documents, help describe the function, architecture, and design of software. Other artifacts
are concerned with the process of development itself, e.g., project plans, business cases, and risk
assessments.

Bidirectional
A source-to-target link. A bidirectional link will update both source and target nodes.

Data
Data refers to an item whose specific format enables it to be synchronized with and referenced to and
from another data. Data can be a MagicDraw® element or relation, a DOORS node or relation, or a CSV
row.

DataHub operations
You can use DataHub operations to copy data, copy data with sync, create OSLC Link, copy data and
create DHTrace, or create DHTrace. The table below describes the functions of the DataHub operations.

Operation Function

Copy Data To copy data without creating any DHLinks.

Copy Data With Sync To copy data and create a DHLink for synchronization.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 286

 Operation Function

Copy Data with DHTrace To copy data and also create DHTrace links between source and target.

Create DHTrace To create only a DHTrace link without any data.

Create OSLC Link To create an OSLC Link.

DataHub tree
A DataHub tree refers to a tree structure designed to show drivers, Data Sources, and items of the
connected Data Sources in DataHub. The tree within DataHub Explorer has two top levels: DataHub
and Data Sources respectively. The tree consists of four drivers (MagicDraw®, DOORS, DOORS Next
Generation, and CSV) and each driver, except DOORS, has one or more Data Sources.

Data Source
A Data Source refers to the project path of an application. A Data Source can be any of the following

• MagicDraw® project
• IBM® Rational® DOORS® client
• IBM® Rational® DOORS® Next Generation client
• CSV file
An application can have more than one Data Source. Each Data Source refers to a specific project path
and has a unique Data Source ID.

You can connect DataHub to the following applications

• MagicDraw®
• IBM® Rational® DOORS®
• IBM® Rational® DOORS® Next Generation
• Data repository in the CSV format.

DHTrace
The DHTrace relationship is a specialization of a Dependency, connecting model elements or sets of
elements that represent the same concept across models. A DHTrace is often used to track
requirements and model changes, typically in the Traceability diagram, a Class, Use Case, Object, or the
Composite Structure diagram.

As changes can occur in both directions, the order of this Dependency is usually ignored. The
properties of the relationship can specify the DHTrace mapping, but the DHTrace is usually
bidirectional, informal, and rarely computable.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 287

Driver
A driver refers to a connector to either an application or to a file. Each driver has a unique Driver ID.
There are three applications (MagicDraw®, DOORS, and Excel) and one data repository in the CSV
format. Each application uses a specific driver. For example, the DOORS driver connects to DOORS and
DOORS Next Generation driver connects to DOORS Next Generation.

Excluded
Excluded refers to the status of an ignored node only in Sync relations. The excluded nodes depend on
the Sync relation that one node can have both Excluded and the other synchronization status.

Global ID
A global ID consists of a Driver ID, Data Source ID, Type ID, and Item ID arranged in order and
separated by a delimiter “/”. Each item or item type in the DataHub tree has a unique global ID.

HP Application Lifecycle Management (HP ALM)

HP ALM is a set of software tools developed and marketed by the HP Software Division for application
development and application testing. It includes tools for requirements management, test
planning and functional testing, performance testing, developer management and defect management.

Item
An item refers to a particular element in the DataHub tree. Each item has a unique item ID. Elements
such as drivers, data sources, folders, packages, DOORS formal modules, requirements (data), and
relationships (links) in the DataHub Explorer tree are called items. A node may have nested children as
items.

Glossary (see page 286) refers to an item whose specific format enables it to be synchronized with and
traced to and from another data.

A link (see page 289) is an item whose specific format can link one data to another and also enables it to
be synchronized with other links.

Item type
An item type consists of a list of properties. For example, a SysML Requirement type consists of two
properties (ID and Text). Thus, every item with the same item type shares the same property list. An
item type can be a driver type, Data Source type, IBM DOORS requirement type,
MagicDraw® stereotype, or CSV column. Each item type has a unique Type ID.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 288

Link
A link is an item whose specific format can link one data to another and also enables it to be
synchronized with other links. A link can only be a MagicDraw® relationship, an IBM® Rational®
DOORS® link, or an OSLC Link. Unlike data, links can only be synchronized. A link is also a URI reference
from one resource, subject, or source to another resource, and can be an object or target. In RDF and
OSLC, we use links to model relationships. Links are unidirectional like relationships.

Mapping mode
DataHub has two types of mapping, Individual Type Mapping and Group Type Mapping. The
Individual Type Mapping shows the same node structure as the dragged nodes, and you need to map
each source node to each target node. The Group Type Mapping groups nodes according to their
types and allows you to map a source type to a target type.

Module
A DOORS container which may contain hierarchically arranged sub-modules. Typically, this is a
requirement specification tree.

Node
A node is like a leaf in a tree. It represents a distinct point within the tree structure. A node can have
children or be a child itself.

Orphan
Orphan refers to the status of an updated item that attempts to synchronize to the other side of the
relation that has been deleted.

OSLC
DataHub, as of this version facilitates OSLC queries. Open Services for Lifecycle Collaboration (OSLC) is
an open community creating specifications for integrating tools. The goal of OSLC is to create
specifications for interactions between tools.

In OSLC, each artifact in the lifecycle, e.g., a requirement, defect, test case, source file, or development
plan, is an HTTP resource that is manipulated using the standard methods of the HTTP specification
(GET, PUT, POST, DELETE).

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 289

OSLC link
The OSLC specification defines relationships, which can be modeled as links.
Types of unidirectional links supported include affectedBy, constrainedBy, constrains, decomposedBy,
decomposes, eleborates, elaboratedBy, implementedBy, and satisfiedBy.

OSLC query
DataHub supports two types of OSLC queries - basic query and advanced query. The basic query is a
simple text based on searching, while the advanced query syntax follows SQL or SPARQL.

PendingDelete
PendingDelete refers to the status of an item that occurs because one or more related items have been
deleted. The PendingDelete status is similar to the Orphan status, but the PendingDelete occurs at
synchronization.

PendingUpdate
PendingUpdate refers to the status of an item that occurs because one or more related items have
been updated (changes have been made to the item(s)). Items in the PendingUpdate status can be
either accepted to update the properties or discarded.

Recursively
When this option is chosen, all the child nodes under the selected node are included. Otherwise, only a
single element is processed.

Relationship
A relationship exists between two resources when there is something that connects them. The two
resources work together, belong together, are similar, or should be considered together. There are
different types of relationships.

Requirements traceability
Requirements traceability is concerned with documenting the life of a requirement and providing
bidirectional traceability between various associated requirements. It enables you to find the origin of
each requirement and track every change that has been made to this requirement.

Requirements include design artifacts, implementation, and are finally verified. The artifacts tied to the
latter stages can be traced back to the requirements as well. This is typically done via a Requirements
Traceability matrix.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 290

Schema map
A schema Map refers to the mapping of attributes between the source and target types. The source
and target types can be identical or different. Apart from mapping, you can also use schema maps to
copy items from different item types and update them for attribute synchronization.

The table below is an example of attribute mapping between MagicDraw® and the DOORS formal
module.

MagicDraw® SysML requirements Functional requirements module

Name Object Heading

Id Object Identifier

Text Object Text

Status
Status refers to the status of an association item. The status of an item varies depending on the
association type (Sync DHLink or DHTrace). If the association type is a Sync DHLink, the item status
will be Synchronized, PendingUpdate, PendingDelete, Excluded, or Orphan. If it is a trace, its status
might be Suspect.

Synchronized
Synchronized refers to the status of relations that the related nodes need to be the same as the other
side or the status of an item that does not have any pending changes.

Sync relation
DHLink synchronizations are associations between data in both source and target items. Items with
DHLink can synchronize one another. DHLink synchronization is available in the Operation drop-down
list in DataHub Explorer.
There are two kinds of DHLink: Unidirectional and bidirectional.

• Unidirectional DHLink synchronization is either from a source to a target or vice-versa. Data is

synchronized in only one direction and not both directions.
• Bidirectional DHLink synchronization refers to two-way synchronization. When the data in the
source is updated, the data in the target item will be updated as well and vice versa. When you
synchronize data with bidirectional DHLink synchronization, DataHub will establish the
consistency in data hierarchy of both items.
If two data items have an Association, they can be open from one another.

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 291

System model
A system model is the conceptual model that describes and represents a system. A system is
comprised of multiple views such as planning, requirement (analysis), design, implementation,
deployment, structure, behavior, input data, and output data views. A system model must describe and
represent all these multiple views.

Unidirectional
This is a one-way synchronization either from a source to a target or from a target to a source.
Unidirectional synchronization changes only one side of the source and target.

Troubleshooting

Server Certificate tool

Generally, all the certificates are managed automatically by the Server Certificate tool. To learn more
about the Server Certificate tool, refer to Server Certificates31. The certificate is manually installed only
when it is not trusted. To learn more about installing certificates manually, refer to 3DEXPERIENCE
troubleshooting32.

31 https://docs.nomagic.com/display/MD2024xR1/Server+Certificates
32 https://docs.nomagic.com/display/MD2024xR1/3DEXPERIENCE+troubleshooting

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 292

Index

D F
Featured 55
Documentation-space-sample 55

Copyright © 1998 – 2024 No Magic, Incorporated, a Dassault Systèmes company. 293