Dassault CATIA Magic

Dassault CATIA Magic Copy link to clipboard

The CATIA Magic adapter supports extraction of traceability information from CATIA Magic projects.

Data access Copy link to clipboard

The CATIA Magic data access configuration specifies the Teamwork Cloud server to connect and the projects to use.

Teamwork Cloud Data access Configuration Copy link to clipboard

Open the ANALYZE configuration with the ANALYZE configuration editor, and add a new data access as described in section "Data accesses".

Select Dassault Catia Magic as data access type.

Supported keywords:

host – (Mandatory) The host name or the server IP address of the Teamwork Cloud installation.
port – (Optional, default 8443) The primary Teamwork Cloud port number.
ssl – (Optional, default true) Whether http or https should be used.
rest-api-port – (Optional, default 8111) The port number for the REST API of the Teamwork Cloud installation.
rest-api-path – (Optional, default „/osmc”) The path to the REST API for the Teamwork Cloud installation.
projects – (Mandatory) A list containing at lest one name (or UUID) of a project from which to fetch data and an optional revision number. Leaving out the revision will use the latest revision.

Sample configuration:

host "twcloud.itemis.de"
port 8443 
ssl true 
rest-api-port 8111
rest-api-path "/osmc"
projects {
 "climate control system.MASTER" revision 4
}

In the example above, ANALYZE will connect to a Teamwork Cloud server at https://twcloud.itemis.de:8443 (using the REST API at https://twcloud.itemis.de:8111/osmc). ANALYZE will consider elements from revision 4 of the project ‚climate control system.MASTER’.

When you first start ANALYZE with the adapter enabled, a dialog will ask you for a user name, password, client-identity & client-secret for the login. You can store this information in Eclipse’s Secure Store such that you don’t need to re-enter it later. If you don’t know them, you will need to ask your Teamwork cloud administrator for a client-identity & client-secret.

You can also provide the login credentials as java system properties CATIA_TWC_LOGIN_USERNAME, CATIA_TWC_LOGIN_PASSWORD, CATIA_TWC_LOGIN_CLIENT_ID & CATIA_TWC_LOGIN_CLIENT_SECRET.
You can set these properties either directly via the the command line or in a configuration file that you specify with ANALYZE’s --properties command line option (see Executing itemis ANALYZE in batch mode ). Alternatively, you can define environment variables with the same names.

Artifact type Copy link to clipboard

Open the ANALYZE configuration with the ANALYZE configuration editor, and add a new artifact type as described in section "Artifact types".

Select your previously-configured Catia Magic data access in the Data access drop-down list.

By default ALL the model elements from your Catia Magic Project element will be included. Usually this is a large amount of data and it is sensible to add filters to reduce the number of elements included.

You can filter by metatype, stereotype & namespace.

Artifact type Configuration Copy link to clipboard

Supported keywords:

subset metatype – Filter the elements by metatype (e.g. uml.Class).
subset stereotype – Filter the elements by the name of an applied stereotype (e.g. Block).
subset namespace – Filter the elements by namespace. I.e. A qualified name through a hierachy of Packages and other elements (e.g. „RootPkg::SubPkg”).
map - Attribute mappings for custom attributes.
attribute( attributeName) – References the value of an element attribute with the name attributeName. Supported attributes are listed via the content assist (Ctrl-Space).

Sample configuration:

subset stereotype  "Block"
subset namespace  "Data::Climate Control System::Test"
map {
	id to attribute(UUID)
	type to attribute(Metatype)
}

In this example only model elements that have a stereotype named ‚Block’ applied to them will be included as Artifacts, and only if those elements are in the package ‚Data::Climate Control System::Test’ or any package transitively contained below it.

The ANALYZE attributes ‚id’ and ‚type’ will correspondingly contain the ‚UUID’ and actual ‚Metatype’ of the Catia Magic model elements.

Link type Copy link to clipboard

The Catia Magic adapter allows to specify which links itemis ANALYZE should import from the Catia Magic data access. Make sure that the required artifact types have been configured first.

Configuration Copy link to clipboard

Open the ANALYZE configuration with the ANALYZE configuration editor, and add a new link type as described in section "Configuring a link type".

For both ends A and B, select a Catia Magic artifact type with Catia Magic as its adapter.
As data access, select your previously-configured Catia Magic data access.

The configuration follows the same format as the Artifact type Configuration with two differences:

a metatype to subset must be defined, and must be a sub type of uml.Relation
the link direction can be swapped with an additional configuration statement

Sample configuration:

subset metatype uml.Association
subset namespace  "Data::Climate Control System::Test"
map {
	id to attribute(UUID)
}
link source is B

In this example only model elements that are Associations will be included as Links, and only if those elements are in the packages ‚Data::Climate Control System::Test’ or any package transitively contained below it.
The UUID of the Association is added as an attribute ‚id’ on the corresponding ANALYZE link.
Additionally the link direction is specified, with the source being Artifact B.

Table of contents