Skip to content

How to use the Add In

Jump to bottom
Leif Halvor Sunde edited this page Oct 14, 2022 · 3 revisions

This page contains instructions on how to use the ShapeChange Add-In for Enterprise Architect. For installation instructions, please see the Installation page.

Generate an XSD

  1. Open an Enterprise Architect project and select a package with the "ApplicationSchema" stereotype:
    image

  2. Right click the ApplicationSchema, select "Specialize" -> "ShapeChange" -> "Transform":
    image

  3. Click on the transform-button, and wait for completion of the process.
    image

  4. A report will be opened in your default web browser. If the process was successful, at the end of the report, in the Results section, the schema is accessible.
    image

Targets

image

Make GML Schema (xsd): Check this box to enable generation of an xsd for the selected ApplicationSchema. (https://shapechange.net/targets/xsd/)

Generate documentation (FeatureCatalogue): Enables the Feature Catalogue target output (https://shapechange.net/targets/feature-catalogue/)

Make external codelists: Enables the GML Codelist Dictionary functionality (https://shapechange.net/targets/dictionaries/gml-codelist-dictionary/)

Tabs

Project Properties

Displays an overview of the project properties.
image
The only editable field, "Shapechange jar" allows the user to override the path to the ShapeChange.jar file. There are, however, no guarantees that a version of ShapeChange different from the one included in this repo will run correctly.

Log

Logging output from ShapeChange is displayed here.
image

FeatureCatalogue

If Generate documentation (FeatureCatalogue) is selected, this section can be used to configure the produced documentation.
image
Format: Select which file-format to produce the documentation in.
Description: Defaults to the text entered in Notes for the selected package.
Producer: Defaults to the value of the tag "SOSI_produsent".
Version date: Defaults to the current date.
Templ. directory: Defaults to the path to the built-in template file.
Templ. filename: Defaults to the built-in template file.
Include diagrams: https://shapechange.net/targets/feature-catalogue/#includeDiagrams
Include voidable: https://shapechange.net/targets/feature-catalogue/#includeVoidable
Include title: https://shapechange.net/targets/feature-catalogue/#includeAlias
Feature term: https://shapechange.net/targets/feature-catalogue/#featureTerm

Settings

image
Java 11 runtime: Path to the JRE 11 runtime executable
Log report level: Select verbosity of the logging output.
Proxy host: If needed, specify the proxy host for the JVM.
Proxy port: If needed, specify the procy port for the JVM.

Clone this wiki locally