Initial Setup (All Editions)

1. Extract the downloaded archive
2. Copy SSJavaCOM.dll (c:\Program Files (x86)\Sparx Systems\EA\Java API\SSJavaCOM.dll) to C:\Windows\SysWOW64 (64-bit systems) or C:\Windows\System32 (32-bit systems)
   If you have to ask the administrator to do that, you can use this link to prove it is safe to install the DLL.
3. Run EASynchro.exe
4. If you already purchased a license, go to settings and activate the product by entering the license key
5. Set Enterprise Architect Repository
   Go to settings and enter EA repository connection string (e.g., PostgreSQL12 - DBType=4;Connect=Provider=MSDASQL.1;Persist Security Info=False;Data Source=PostgreSQL12;LazyLoad=1;) or the path to the EAP file (e.g., C:\repo.eap)
6. Set up Confluence
   Enter the Confluence host server and the credentials. All changes to Confluence done by the applicaton will be performed on behalf of this user.
   To generate interactive diagrams images (a note is displayed on mouse over and it is possible to navigate to subdiagrams), enable HTML macro, or install Interactive Content Plugin .
7. Professional and Enterprise Editions: setup database and create artifact pages templates (see below)
8. Now you're ready to open the EA repository and generate your first Confluence page 😊

Initial Setup (Professional and Enterprise Editions)

Set artifact pages templates

If you want every newly created artifact page (use case page, system page etc.) to have a predefined content, create a template:

1. Go to settings and set the space containing the templates
2. In this space, create a page for each artifact you want to be based on a template
   For documentation templates, create pages UC, SYS* etc.
   For project templates, create pages PROJ UC, PROJ SYS etc.

* PROC, TRM, REQ, BR, UC, ACTR, PRV, ACT, FCN, IF, SVC, SCR, UI, DOC, DO, DF, TAB, SYS, MOD, SMD, PROJ, DOM, PTY

Database Setup (Professional and Enterprise Editions)

EASynchro can be configured to work with the standalone database system, or it can use the embedded one. The embedded database does not require any installation or configuration, but since the data is stored on the local computer, it can't be accessed by other EASynchro instances.

 

Standalone Database

1. Create an empty PostgreSQL database
2. Create the database schema by running the EASynchro.sql script included in the application ZIP file
3. Grant your PostgreSQL user access to the created EASynchro tables
4. Go to settings and enter database details in the Database Settings section
5. Now you can start giving semantics to Enterprise Architect's elements by mapping them to software development artifacts and get the full potential of the automatically generated documentation in Confluence

Embedded Database

1. Select "Use embedded database" in the settings
2. Select EASynchro.sql script included in the application ZIP file
3. Save the settings - the application automatically initiates the embedded database, so it is immediatelly ready to use.

Local Settings vs. Central Settings

1. Local settings are stored in your computer, central settings are stored in the database. For the Basic license, the local settings are the only choice as connecting to the database is not supported.
2. Users of the Professional and Enterprise licenses can choose whether to use the local settings or load the settings from the central database.
   Central settings are typically used in a multi-user environment when it is necessary for every team member to use the same settings.
   The administrator enters the settings just once in the admin settings section and all team members then apply them by selecting to use the central settings.

Default admin settings password: admin

Dual-repository Setup (Enterprise Edition)

1. The initial EA repository setup is a single-repository setup meaning that the elements describing the current state reside in the same repository as the future state elements. The more powerful approach is to separate the as-is from to-be as described here.
2. Go to admin settings
3. Turn on the the dual-repository setup and enter the working (to-be) and documentation (as-is) repositories details
4. Go back to settings and turn on central settings
5. Restart the application and you should now be able to switch between the repositories