This export creates an HTML site from the Enterprise Architect model stored in an EAP file. This is the same report that can also be created using the Enterprise Architect's GUI. But the plugin allows to integrate the generation process into the project's build process.

Parent
Tags
Iteration
Filled

Description

Add the following to you POM to integrate the plugin into your Maven build process to only generate the HTML site for you Enterprise Architect model:

<build>
  <plugins>
    <plugin>
      <groupId>de.smartics.maven.plugin</groupId>
      <artifactId>smartics-ea-maven-plugin</artifactId>
      <version>1.0.0</version>
      <executions>
        <execution>
          <id>ea-export</id>
          <goals>
            <goal>export</goal>
          </goals>
          <phase>pre-site</phase>
          <configuration>
            <generateHtmlSite>true</generateHtmlSite>
            <eaProjectRepositoryFile>path/to/your/model.eap</eaProjectRepositoryFile>
          </configuration>
        </execution>
      </executions>
      <dependencies>
        <dependency>
          <groupId>de.smartics.sparxsystems</groupId>
          <artifactId>eaapi</artifactId>
          <version>11.1.1112</version>
        </dependency>
      </dependencies>
    </plugin>
  </plugins>
</build>

Replace the content of the element eaProjectRepositoryFile with the actual path to your EAP file.

JAR provided by Enterprise Architect

We are not allowed to publish the JAR required to access the Enterprise Architect. Therefore you have to provide this JAR file as a dependency in your configuration by yourself.

This are the artifact coordinates we have chosen:

<groupId>de.smartics.sparxsystems</groupId>
<artifactId>eaapi</artifactId>
<version>11.1.1112</version>

Your coordinates should differ and you are free to name them any way as long as you add the artifact to the plugin's dependencies as shown above.

 

Please note that we have choosen a groupId prefixed by de.smartics to not interfere with the namespace of com.sparxsystems.

The referenced artifact is created and copyrighted by Sparx Systems!

Also note that the version number used above is the version the plugin has been compiled with. Since there is no version information in the JAR we chosed the version of the Enterprise Architect the JAR is bundled with. It is very likely that other versions will also be compatible with this plugin. So you are probably not forced to use this exact version.

Resources

Export XMI Packages as Image Files
This export allows to create single images of your Enterprise Architect packages (i.e. diagrams) with their GUID as file name. Since the GUID of the diagram does not change, this is a perfect way to export your diagrams to be referenced from your documentation.
smartics-ea:export
Information about the goal to export Enterprise Architect resources from an EAP file. This page lists all parameters.
Accessing Artifacts
Shows how to reference the smartics Artifact Repository.