Skip to content

2. Configuring the plugin

Jump to bottom
herve91 edited this page May 3, 2018 · 5 revisions

The plugin can be configured through a dedicated preference page that can be accessed using Archi's preferences menu option.

This preference page has got two tabs:

  • Behaviour
  • Logger

Behaviour

The Behaviour pages allows to configure the databases and options.

Version

The plugin shows its version.

The Check for update button connects to to GitHub to verify available versions, and automatically update itself if a new version is available.

This check can be automated when Archi starts using the Automatically check for update at startup option.

When behind a corporate proxy, the following lines must be added to the archi.ini file: `-Dhttp.proxyHost= -Dhttp.proxyPort= -Dhttp.proxyUser= -Dhttp.proxyPassword=

-Dhttps.proxyHost= -Dhttps.proxyPort= -Dhttps.proxyUser= -Dhttps.proxyPassword=

-Djdk.http.auth.tunneling.disabledSchemes= -Djdk.http.auth.proxying.disabledSchemes=`

Databases

You may configure one or several databases that the plugin will be able to connect to. database plugin - preference page - behaviour

You may enter your database connection information (the fields are shown when relevant, else, they are hidden):

  • Name: this is a label you may give to your connection
  • Driver: a dropdown list allows you to select the driver that will be used to connect to the database. So far, the following are supported : ms-sql, mysql, neo4j, oracle, postGresql and sqlite).
  • File: (specific to SQLite databases) file name containing the database
  • Server: the IP address or DNS name of the server which hosts your database.
  • Port: the TCP port your database listens to
  • Database: the database name to connect to
  • Schema: the name of the schema containing the tables
  • Username: the username used to connect to the database
  • Password: the users's password
  • Export type: you may choose if the database must contain the whole model (including views and images) or the elements and relationships only
  • _Export mode": you may choose between the Collaborative mode and the Standalone mode (more information on the Exporting a model page)
  • Export view Images: you may choose if you wish to store screenshots of your views in the database (png format).
  • Export graph mode: (specific to Neo4J databases) In native mode, Archi relationships are exported as Neo4J relationships which does not allow relationships on relationships. In extended mode, Archi relationships are exported as nodes which make requests more complex but does allow relationships on relationhips.
  • Empty database: (specific to Neo4J databases) allows to empty the database before exporting the model or to keep the existing graphs

Debug

You shouldn't need to require debugging information but they are accessible on Archi console. It is a very simple mechanism which allow to select the level of required information :

  • debug main methods : prints a line when entering and leaving important methods
  • debug secondary methods : prints a line when entering and leaving non important methods
  • debug variables : prints a line with some variable values
  • debug database requests : prints a line with all the SQL requests run against the database

Archi console can be shown up when Archi is run with the "-console" parameter (i.e. "Archi.exe -console" on Windows).

Clone this wiki locally