Reading and Writing System Architect Data

Connectors

Model Readers:

• Application: live connection to System Architect
• Application (diagrams): live connection to System Architect, with diagram pictures being retrieved.
• XML: System Architect XML file format
• XMI

Model Writers:

• Application: live connection to System Architect
• XML: System Architect XML file format
• XMI 2.1

Application Connector

"Application" reader and writer connect to the encyclopedia assumed to be open in an active System Architect application.

Collision Flag

The "Application" writer uses a integer property named collisionFlag that specifies which collision heuristic is used by System Architect application to merge the data in the encyclopedia. The default heuristic is the number 1. Possible values are:

• 0 - Never overwrite an existing definition or diagram;
• 1 - If the definition exists, get all properties for it, delete it, recreate it, repopulate the properties;
• 2 - Update single fields when data supplied;
• 3 - Update single fields - clear field if no data;
• 256 - Always replace existing diagram.

Reader Scope

The Application and XML readers can read only a subset of the encyclopedia. The following properties controls the reading of Definitions and of Diagrams:

• sa.scope.definition = none/name/full
• sa.scope.diagram = none/name/full

Here are the scope possible values:

• none: the corresponding elements are skipped.
• name: only the element name and type are read.
• full: the element and its children are read (e.g. Diagram, Symbols, Properties, etc.).

API Reference