Installation Manual

Installation Manual EA Infoport Team Thu, 07/16/2020 - 09:27

Installation Manual

Administrator's guide to installing, updating and administering the Enterprise Architect Information Portal. The manual is valid for version 7.3.

This documentation contains the complete information needed to install the EA Infoport application to various databases, the basic requirements, information on how to update the portal, both manually and automatically, as well as how to administer the portal.

The manual is created in the form of an electronic book – so you can read the book chapter by chapter or choose from the outline.

eainfoport logo

 

 

Basic Requirements

Basic Requirements EA Infoport Team Thu, 07/16/2020 - 09:44

Basic Requirements

This chapter contains basic software and hardware requirements for the Enterprise Architect Information Portal application to function properly.

Required Hardware

Required Hardware EA Infoport Team Thu, 07/16/2020 - 09:46

Required Hardware

The Enterprise Architect Information Portal requires the following hardware to function properly.

 

Name

Version

Description

RAM

4 GB

8 GB

HDD

50 GB

150 GB

CPU

Intel® Pentium® 

Intel® Pentium® 

 

 

Required Software

Required Software EA Infoport Team Thu, 07/16/2020 - 09:48

Required Software

The Enterprise Architect Information Portal requires the following software and libraries to function properly.

Name

Version

Description

Supported databases

12c+

5.7.7+

SQL Server 2012

12+

Oracle

MySQL

MSSQL

PostgreSQL

Enterprise Architect (not included)

14+

easetupfull.msi

EALite.exe

Net Framework

 

4.7.1

NDP471-KB4033342-x86-x64-AllOS-ENU

Supported operating systems

Windows 10 Version 1607+

Windows 2012+

Windows 10 Client

Windows Server

Installation Procedures

Installation Procedures EA Infoport Team Thu, 07/16/2020 - 10:05

Installation Procedures

The installation procedure for commissioning EaInfoportT3 on your own server. All components must be installed under a Windows user account (e.g.: technical user). Therefore, not under an account, such as system service.

Note: All underlined information in the installation is provided as an example and is likely to vary in your installation.

Note: When migrating to a new version, it is better to back up the database for security reasons.

Enterprise Architect Installation and Configuration

Enterprise Architect Installation and Configuration EA Infoport Team Thu, 07/16/2020 - 10:10

Enterprise Architect Installation and Configuration

It comprises the following steps:

  • Installation of the Enterprise Architect program
  • Database installation
  • Installation of ODBC drivers for database access
  • Optimal zoom setting in Enterprise Architec

The user will use C:\EAInfoport as the main folder for installing Dataprojekt applications in this manual.
In addition to executable files, various configuration files will be saved here.
If necessary, you can use any other folder with write permission.

Installation of the Enterprise Architect program

Installation of the Enterprise Architect program EA Infoport Team Thu, 07/16/2020 - 10:17

Installation of the Enterprise Architect program

 

  1. Download the easetupfull.exe or ealite.msi file from https://sparxsystems.com/ and save it on the local disk (for example in the folder C:\EAInfoport).
  2. Run the easetupfull.exe or ealite.msi file
  3. Use the wizard to install the application
    1. Read and confirm the EULA
    2. Leave the default directory C:\EAInfoport\Sparx Systems\EA for the installation
  4. After the installation is complete, delete the easetupfull.exe file (or ealite.msi)
  5. Run the Enterprise Architect application
  6. In the licence management, fill in the name and title of the company and the registration key (four groups of four letters and numbers), confirm the dialogue and close it
  7. In the following dialogue for version activation, enter the activation code (four letters and numbers)

This completes the installation of Enterprise Architect and the application is ready for use.

Installation of the Database to Save Enterprise Architect Model

Installation of the Database to Save Enterprise Architect Model EA Infoport Team Thu, 07/16/2020 - 10:24

Installation of the Database to Save Enterprise Architect Model

If a database engine is installed on the computer or available on the network, it is possible to skip this chapter.

Here you can learn how to install one of the supported database engines.
The one we’re using is MySql, which is recommended as ideal for the needs of both the Enterprise Architect program and EaInfoport

For proper functionality, it is necessary to use the 5.7.x series; version 8.x is not suitable

  1. Before installing MySQL, it is necessary to ensure that the vcredist_x86.exe helper package in version 2013 is installed on the computer. Search the internet for “Visual C++ Redistributable Packages for Visual Studio 2013”, save the vcredist_x86.exe variant to the disk and run it.
    After approval of the licence, the package will be installed. There is no need to restart the computer. Delete the vcredist_x86.exe file
  2. Download the 32-bit web installer for the 5.7.x series from https://downloads.mysql.com/archives/installer/. So currently mysql-installer-web-community-5.7.28.0.msi
    Save the file to the local disk (for example, to the
    C:\EAInfoport folder)
  3. Run the file
  4. Select Custom as the installation type
    MySQL Installer
  5. Select two items to install:
    MySQL Server 5.7.x – X86
    Connector/ODBC 5.3.x – X86

    MySQL Installer 2
  6. On the next tab, start the MySQL installation
    MySQL Installer 3
  7. Leave the settings on the other tabs as default.
    Only on the tab with the settings of accounts and roles, first fill in the root password (for the database administrator) and then create a user infoport, under which you will log into the database later.
    All passwords (mainly the administrator ones) should be secure. For demonstration purposes, we use the phrase P@ssw0rd as a password in the manual. (It will be seen later in the connection definition.)

    MySQL Installer 4
    MySQL User Acount
  8. Delete the mysql-installer-web-community-5.7.28.0.msi  installation file from the disk.
    This completes the installation of the database and the ODBC driver (but it will still need to be configured – see below)

Creating a database for an Enterprise Architect model

Creating a database for an Enterprise Architect model EA Infoport Team Thu, 07/16/2020 - 10:58

Creating a database for an Enterprise Architect model

  • Download the database script to create the necessary tables from https://sparxsystems.com/downloads/corp/scripts/EASchema_1220_MySQL.sql
  • Save the EASchema_1220_MySQL.sql file in the directory C:\EAInfoport\Dataprojekt
  • Start the (line) program MySQL 5.7 Command Line Client
  • Log in with the root (administrator) password
  • Create the database “ea” using the command CREATE DATABASE ea;
  • Switch to the database using the USE ea command;
  • Create the tables needed for Enterprise Architect to work with the command SOURCE C:\EAInfoport\Dataprojekt\EASchema_1220_MySQL.sql
  • End the program

Installation and Configuration of ODBC Drivers

Installation and Configuration of ODBC Drivers EA Infoport Team Thu, 07/16/2020 - 11:13

Installation and Configuration of ODBC Drivers

If you have installed a MySQL database (according to one of the previous chapters), continue with the ODBC configuration.

For EaInfoport to work, Enterprise Architect needs to have data saved in a relational database (not just in .eap file).
ODBC drivers are required to connect Enterprise Architect and the database. They are freely available for all supported database types.
Below is a detailed procedure for MySQL, for other databases the procedure is similar.

ODBC Installation for MySQL

ODBC Installation for MySQL EA Infoport Team Thu, 07/16/2020 - 11:15

ODBC Installation for MySQL

  • Download the installation file for the 32-bit version from the 5.x.x series from https://downloads.mysql.com/archives/c-odbc/. So currently mysql-connector-odbc-5.3.13-win32.msi.
    Save the file, for example, to the folder
    C:\EAInfoport\Dataprojekt
  • Start the installation, confirm the licence, complete the installation
    Delete the installation file

ODBC Configuration for MySQL

ODBC Configuration for MySQL EA Infoport Team Thu, 07/16/2020 - 11:19

ODBC Configuration for MySQL

  • Start the ODBC connection management application “ODBC Data Sources (32-bit)
  • Switch to the User DNS tab (attention: important!)
  • Add a new Data Source type “MySQL ODBC 5.3 ANSI Driver”
  • Fill in the connection parameters according to the following pattern (and according to the values you entered when installing the MySQL database), and do not forget the Detailed Settings
    • Data Source Name = ea
    • TCP/IP Server = localhost
    • User = infoport
    • Password = P@ssw0rd

MySQL

Connection tab 

  • Check Allow big result sets
  • Check Allow multiple statement

MySQL 1

Cursors/Results tab

  • Check Return matched rows instead of affected rows

MySQL 2

Misc tab

  • Check Prepare statements on the client

MySQL 3

  • Save the settings
  • Now you can close the ODBC Data Source Administrator application (32-bit)

Save an Enterprise Architect Model to a Database

Save an Enterprise Architect Model to a Database EA Infoport Team Thu, 07/16/2020 - 12:21

Save an Enterprise Architect Model to a Database

If you do not have any EA model yet, create it (or open a sample one).

  • In the Enterprise Architect application, start the Open Project command from the main menu (below the EA icon)
  • Select Local File and find the file C:\Users\Administrator\AppData\Roaming\Sparx Systems\EA\EAExample.eap

If the EA project is not saved yet in a database (for example, because it has been just installed according to the previous chapters), then save it.

  • Open the Project Transfer dialog using the Configure | Model | Transfer ribbon
  • Select File to DBMD
  • Enter C:\Users\Administrator\AppData\Roaming\Sparx Systems\EA\EAExample.eap as a Source Project
  • As a Target Project, enter the following into Data Ling Properties:
    • On the Provider tab, select Microsoft OLE DB Provider for ODBC Drivers
    • On the Connection tab
      • In part 1 (… source name…), select the ODBC connection value, i.e. ea ea
      • In part 2 (… log on…), enter the name of the root user of the database (administrator) and its password. In our case root and P@ssw0rd
      • In part 3 (… catalog…), select the name of the database schema, i.e.ea
    • Test the connection and confirm
  • Enterprise Architect copies the content of the project from the file to the database (and will be available for the EaInfoport system).
  • The last step is to open the project from the database.
    • From the main menu (below the EA icon) start the Open Project… command
    • Select Connect to Server and fill in the same data as we used in the previous step to connect to the database.
    • After confirmation, we are connected to the project saved in the database.

Create a Link to the Repository

Create a Link to the Repository EA Infoport Team Thu, 07/16/2020 - 12:33

Create a Link to the Repository

Once we have the EA model stored in the database, it is necessary to create a shortcut that will use the EaInfoport system.

  • In the Enterprise Architect application, start the Save as shortcut command from the main menu (below the EA icon).
  • Select the folder where you want to create the shortcut (e.g. C:\EAInfoport\Dataprojekt\ea.EAP) and confirm.
  • As soon as you connect a new repository in the EaInfoport administration, you will work with this file.
  • To verify the functionality of the link, first turn off the Enterprise Architect program. Then find the file with the link CC:\EAInfoport\Dataprojekt\ea.EAP  on the disk and “run” it (double click).
  • If Enterprise Architect also opened with our project, everything is set and saved correctly.

Optimal Zoom Setting

Optimal Zoom Setting EA Infoport Team Thu, 07/16/2020 - 12:39

Optimal Zoom Setting

The quality of diagram display in EaInfoport depends on the setting of a special Scale parameter in Enterprise Architect.

  • In the Enterprise Architect application, open the Preferences dialogue (CTRL + F9)
  • Select “Diagram” in the left part
  • In the General section, set “Scale Saved Bitmaps to” to 400% and “Image Memory Limit” to 25

diagram

Setting an Element Size in a Diagram

Setting an Element Size in a Diagram EA Infoport Team Mon, 12/14/2020 - 08:42

Setting an Element Size in a Diagram

  • Settings required for each project!

If you want to use Infoport to edit a diagram, open Enterprise Architect, click on the Configure tab, then go to the Options tab. In the window that will open, click on Cloud and check the option Auto create Diagram Image and Image Map (each time a Diagram is saved).

EA na ticket otázky a odpovědi

InfoportLauncher

InfoportLauncher EA Infoport Team Thu, 07/16/2020 - 12:50

InfoportLauncher

InfoportLauncher.exe is a program for installing and updating the EaInfoport system.
It autonomously downloads, installs and runs EaInfoport and ensures its regular updates.

It is configured using command line parameters. If you run it without parameters, “InfoportLauncher.exe” will show basic help with a list and description of all available parameters.

InfoportLauncher.exe is a “portable” program that is installed by simply copying it to a disk. We recommend copying it to the folder “C:\EAInfoport\Dataprojekt\Infoport

How the Program Works

How the Program Works EA Infoport Team Thu, 07/16/2020 - 12:52

How the Program Works

The program first checks the basic requirements for the environment in which it is running.
If it is configured to automatically download current versions from the ftp server, it will detect the latest available version of EaInfoport, download it and install it.If access to ftp is disabled for security reasons, it is possible to manually download EaInfoport.zip from the website and copy it to the same directory as InfoportLauncher.exe.
It will already ensure the installation. InfoportLauncher.exe can also check if the EaInfoport system is running and start it if necessary.

 

Parameters

Parameters EA Infoport Team Thu, 07/16/2020 - 12:56

Parameters

InfoportLauncher.exe can be run with the following parameters:

„InfoportLaunch -Trigger -Source -Scope -Version -Port -Start -Stop -Clear -Prereq -Run“

Trigger "* * * * *"

Trigger "* * * * *" EA Infoport Team Thu, 07/16/2020 - 12:57

Trigger "* * * * *"

This parameter sets the period during which InfoportLauncher.exe performs its activity. The standard Cron format is used. It consists of five parts that describe time and date information. Gradually it is min (0 - 59), hour (0 - 23), day of month (1 - 31), month (1 - 12), day o week sd (0 - 6) (0 = Sunday) If the details are not important, they are replaced with *

This is best understood with examples:

  • If you want to schedule an activity for each hour, use "0 * * * *", which means: at zero minutes, every hour, every day of the month, every month, any day of the week.
  • If you want to schedule an activity always an hour after midnight, use "0 1 * * *", which means: at zero minutes, the first hour of the day, every day of the month, every month, any day of the week.
  • If you want to schedule an activity always at half past two a.m. early Saturday morning, use "30 2 * * 6", which means: thirty minutes, of the second hour of the day, the sixth day of the week (on Saturday) regardless of the day of the month or month.

Source ftp | file

Source ftp | file EA Infoport Team Thu, 07/16/2020 - 13:05

Source ftp | file

Switch between automatic and manual download of zip files with updates. If we set ftp, then InfoportLauncher.exe autonomously downloads (via ftp protocol) files and the administrator does not have to worry about anything. The file option is suitable in cases (especially for corporate companies), where there are security rules prohibiting programs from accessing outside their own domain.

In case of manual download of .zip files, it is always necessary to copy these “next to” the InfoportLauncher.exe program (i.e. for example to the folder “C:\Program Files (x86)\Dataprojekt\Infoport”). Furthermore, the program will perform the update itself. The downloaded zip file must not be renamed or unpacked in any way. It is only advisable to check whether the hash of the downloaded file (zipper) agrees with what is stated on the website from where the file was downloaded. It is possible to use any utility for calculating MD5 hashes for checking (for example, in the Total Commander tool, in the File menu, there is an option Create file with CRC data checking)

Version "* * * *"

Version "* * * *" EA Infoport Team Thu, 07/16/2020 - 13:06

Version "* * * *"

You can use the Version parameter to filter which updates the administrator wants to install. The parameter consists of four parts, major, minor, build, revision. If any details are not important, they are replaced with *

The individual weights of the parameter are:

  • major – usually released once a year/several years. These are major changes and improvements to the system
    minor – usually released once a month/several months. As part of these changes, new functionalities are added and there are also changes in the database structures
    build – they add minor improvements, and above all they fix bugs. They are released weekly
    revision – a technical version that can serve as a hotfix for a problem found with a specific customer

It is best to give examples again to understand the appropriate settings.

  • If you want to agilely install each released version, use "* * * *". This will guarantee that the new version will be installed as soon as it is released.
  • If, on the other hand, you want to approach the updates conservatively, set the parameter to "* * 0 *", which means that the individual builds will not be tightened, but we will wait for the minor version.
  • For corporate customers, it is also advantageous to be able to use this parameter to separate the live environment from the environment intended for testing/adoption of a new version. In that case, for example, in the live installation set "7 3 0 *" (you will fix the previously adopted version) and in the test installation set, for example, "7 4 * *" (thus you will receive all fresh updates)

Port 00000

Port 00000 EA Infoport Team Thu, 07/16/2020 - 13:09

Port 00000

The Port parameter is used only when installing and starting the EaInfoport system for the first time.
This parameter specifies which port the system will operate on until the portal administrator configures it.
EaInfoport is configured using itself (Setup page).
If the standard port 80 was already occupied by another web server, it would not be possible to start the Setup page in EaInfoport at all. Therefore, it is possible to set the port number to any free number.
After configuring the portal, this parameter is ignored.

 

Start automatic | manual

Start automatic | manual EA Infoport Team Thu, 07/16/2020 - 13:09

Start automatic | manual

This parameter is used to refine the behaviour of InfoportLauncher.exe during updates.
If it is set to automatic, it will start EaInfoport after installing a new version.
If the value is manual, EaInfoport must be run by the administrator.

Setting to automatic also guarantees that the start of EaInfoport is checked whenever the version update is checked (which is given by the Trigger parameter). See also Run parameter.

Stop automatic | manual

Stop automatic | manual EA Infoport Team Thu, 07/16/2020 - 13:11

Stop automatic | manual

This parameter is used to refine the behaviour of InfoportLauncher.exe during updates.
If it is set to automatic, it will turn off EaInfoport after installing a new version.
This setting makes sense especially if the Start parameter is also set to automatic.
After that, the whole update will be performed without an intervention of the system administrator.

Clear automatic | manual

Clear automatic | manual EA Infoport Team Thu, 07/16/2020 - 13:11

Clear automatic | manual

This parameter is used to refine the behaviour of InfoportLauncher.exe during updates.
If it is set to automatic, it will uninstall (delete) EaInfoport after installing a new version.

Deletion only applies to the directory with the specific version and does not affect the database with data.

Prereq force | check

Prereq force | check EA Infoport Team Thu, 07/16/2020 - 13:12

Prereq force | check

Each time you run InfoportLauncher.exe, the program verifies that the environment is eligible to install, update or run EaInfoport.
In particular, it checks that there is enough disk space and whether Enterprise Architect is installed

If all the prerequisites are not met and the parameter is set to force, InfoportLauncher.exe does not proceed and displays an error message.
However, if the parameter is set to check, the problems will also be checked and listed, but the program continues to run.
The consequences (such as a lack of free disk space) will take effect later.

Run force | check

Run force | check EA Infoport Team Thu, 07/16/2020 - 13:13

Run force | check

It checks at regular one-minute intervals whether EaInfoport is running.
If not and the value of the parameter is set to check, it will display information that the currently installed version is not running.
If the value of the parameter is set to force, InfoportLancher immediately runs EaInfoport (and displays information about it)
.

Firewall Settings on the Server

Firewall Settings on the Server EA Infoport Team Thu, 07/16/2020 - 13:14

Firewall Settings on the Server

In the standard way (according to the used firewall), enable the port (for incoming requests), on which you want EAInfoportT3 to be available – for example 80 or 8080

Preparing an empty database (or schema) for EA Infoport metadata

Preparing an empty database (or schema) for EA Infoport metadata EA Infoport Team Fri, 09/10/2021 - 12:47

Preparing an empty database (or schema) for EA Infoport metadata

To install Infoport, you need to have an empty schema created in the database that you want to use for application metadata. 

You will use the created schema in the configuration manager where you will reference it.
When you first start Infoport, the necessary database tables are created in the schema for the application to run correctly and the default application settings are also created. 

Configuration Manager

Configuration Manager EA Infoport Team Thu, 07/16/2020 - 13:18

Configuration Manager

After running EaInfoportT3.exe for the first time, the console tells us that it is listening on a localhost with a certain port..
http
After entering the URL into the web browser, the “Configuration Manager” will load.
The first run of the manager is used to create the appsettings.json file, which saves certain parameters for the operation of Infoport
.

Licence Key

Licence Key EA Infoport Team Thu, 07/16/2020 - 13:51

Licence Key

The licence key will be sent to you by Dataprojekt s.r.o.

In the first section, you insert the licence key and set the expiration time of the user's login.
licenční klíč


Automatic Logout Time is a security feature that is used to automatically log out when inactive for a long tim.
automatic logout time

infoport database data

Infoport Connection

Infoport Connection EA Infoport Team Thu, 07/16/2020 - 13:42

Infoport Connection

The first section in the configuration contains the Infoport database settings. (Database schema in which the program has all settings stored)

infoportdatabase

In the first item, we choose the type of database. There is a choice of three types.

  1. MySQL with default port 3306
  2. Microsoft SQL Server with default port 1433
  3. Oracle with default port 152

After selecting the type, the value of the Port item will be filled in automatically.

DBMS
 

The second item is setting the IP address of the database server. (If Infoport runs on the same machine with the database, just fill in the local IP address)
server

 

The third item is the database server port setting. By default, the pre-filled data according to the database type can be changed.
port


The fourth item is only relevant for MySQL and Microsoft SQL Server.
Fill in the name of the schema in which Infoport will create its tables. (If the schema is not created on the database server, Infoport will create it itself, provided the user has sufficient permissions in the database).

database


The other two items are user and password. You need to fill a user who has DML and DDL rights into our chosen database.
user


The Timeout item is used to set the maximum length of a query within the database. It has an effect mainly on queries during the search.
timeout

URLs

URLs EA Infoport Team Thu, 07/16/2020 - 13:48

URLs

In the second section, we will determine to which URL Infoport will listen.

The URL consists of three parts.
The first one specifies the protocol (http or https); the second one is the IP address, and the third one is the port.
If we want to use https (see below), the certificate must be issued to the same IP address as specified here.

urls
 

Other items to fill in are the path and password to the certificate to the URL entered above.

certificate
 

If you want another URL to which the portal will listen, press the  add row button and new items will be created to fill in.

Serilog

Serilog EA Infoport Team Thu, 07/16/2020 - 13:52

Serilog

The third section allows us to set the Infoport logging.

 

The first item is a check box that says whether user activities should be logged. (List of visited URLs).
insighs

In the second item, we choose the relative path for saving logs.
Log path

In the third item, we select the type of logging.
(Each type is described in the table. We recommend Information logging.)

logtype

Table for logging types.

Level (from the most detailed to the least detailed)

Description

Verbose

For information that's typically valuable only for debugging. These messages may contain sensitive application data and so shouldn't be enabled in a production environment. Disabled by default.

Debug

For information that may be useful in development and debugging. Example: Entering method Configure with flag set to true. Enable Debug level logs in production only when troubleshooting, due to the high volume of logs.

Information

For tracking the general flow of the app. These logs typically have some long-term value. Example:Request received for path/api/todo

Warning

For abnormal or unexpected events in the app flow. These may include errors or other conditions that don´t cause the app to stop but might need to be investigadet. Handled exceptions are a common place to use the Warning log level. Example: FileNotFoundException for file quotes.txt.

Error

For errors and exceptions that cannot be handled. These messages indicate a failure in the current aktivity or operation (such as the current http request), not an app-wide failure. Example log message: Cannot insert record due to duplicate key violation.

Fatal

For failures that require immediate attention. Examples: data loss scenarios, out of disk space.






























 

 

 

In the fourth item, we select where we want the logs to be written. We have three options: Console, File or Both.
service log write to


In the fifth item, we choose how often the log file should be closed.
rollinginterval

Here we can see the chosen day. This means that a new log file is created for the portal every day. Logs from previous days remain on disk.

After filling in, just press the checkbutton and the manager will tell you if everything is OK.
 

LDAP Setup

LDAP Setup - Active Directory EA Infoport Team Thu, 07/16/2020 - 13:46

LDAP Setup - Active Directory

In this section, we set up Active Directory using the LDAP protocol.

The first three items are check boxes.

The first field determines whether we want Infoport to work with AD.
The second field determines whether users automatically log in to the AD when they enter the Infoport URL in the browser.
The third option allows us to choose whether we want a user who is not in AD to log in as a guest of the portal.

active


Other items are AD server data. The IP of the server, the name and password of the user under which we will query the AD.
ip

Environment

Environment EA Infoport Team Thu, 07/16/2020 - 13:48

Environment


The first item is a check box that determines whether we want to save published images to the database.
In the next three items, we choose the relative path in which the published images, cached images and temporary files will be saved.


env

Infoport in the Background

Infoport in the Background EA Infoport Team Thu, 07/16/2020 - 14:04

Infoport in the Background

Infoport performs various background functions. 
Some can be set by a user, others run according to default settings. 
A user can find configurable functions in the “appsettings.json” file.
The functions mainly work with repositories.

In the Configuration Manager, a user selects some background functions.

After it has been started, the function starts working in the background and gradually loads the tree for a user (the function is named InitialLoadCacheDeep in the Background section).

cache deep

SynchronizeADUserJob

SynchronizeADUserJob EA Infoport Team Thu, 07/16/2020 - 14:12

SynchronizeADUserJob

Synchronization with Infoport users is for users from AD. 
The function is called SynchronizeADUserJob
Again, it has a cron item to run synchronization on a regular basis. 
 

CreateUser a AddUserToGroup

CreateUser is a flag if we want users from AD to be created in Infoport. 
AddUserToGroup is a flag if we want users to be added to group.

ad
 

SynchronizeSparxUserJob

SynchronizeSparxUserJob EA Infoport Team Thu, 07/16/2020 - 14:12

SynchronizeSparxUserJob

We will now discuss the function for synchronizing Sparx users with Infoport users. 
The function is called SynchronizeSparxUserJob
It contains a single item for setting (cron settings). 
According to the specified settings, users are synchronized regularly. 

sparx
 

Startup Jobs

Startup Jobs EA Infoport Team Fri, 08/28/2020 - 14:43

Startup Jobs

Are processes that are activated only once at the application’s launch and perform actions that need to be performed before users start using the application.

PrefetchRepositoryCacheJob

Prefetch Repository Cache Job EA Infoport Team Thu, 07/16/2020 - 14:06

Prefetch Repository Cache Job

Each time the application is launched, a basic part of the repository tree is loaded from the database into the memory cache.
The reason is the acceleration of user’s work while strolling through the tree. 
The amount of loaded levels depends on the parameters „Initial Load Cache Deep“ and „Maximum Auto Cache Deep“.

The first one Initial Load Cache Deep” indicates how many levels have been loaded before the application starts to obey” and is available for the users. 
Here it is suitable to choose 3 to 5 levels. 

  • The value 3 if the repository is ordered more to the width and there is a larger amount {>>50} of models or packages.
  • The value 5 for the packages ordered more into the depth.

Initial Load Cache

If the value of the other parameter Maximum Auto Cache Deep” is set larger than the first one (7 to 13 is recommended), the data loading into the cache goes on even after the application is available for the users.
It goes on this way gradually up to the depth of the tree that is given by this parameter.

maximum

If a random user strolls through the tree deeper than it is set in the parameter for the maximum automatic download (“Maximum Auto Cache Deep”), the cache grows larger with the displayed data.
Other users thus get a significantly accelerated display. 
These cached data then (if arranged so) influence how some other jobs (“Regenerate Repository Tree”, “Regenerate Existing Image”, “Regenerate Missing Image”) can work.
 

Scheduler Jobs

Scheduler Jobs EA Infoport Team Fri, 08/28/2020 - 14:45

Scheduler Jobs

Are processes that are activated regularly and serve to keep the application in good condition. These include refreshing data in a memory and disk cache, various data synchronisations, and deleting unnecessary data and system processes.

Common settings by all scheduled Jobs

Common settings by all scheduled Jobs EA Infoport Team Fri, 08/28/2020 - 14:56

Common settings by all scheduled Jobs

The basic parameter for each job is the information about the periodicity in that it runs. 
It is possible to set its launch once a minute or, for example, just once a month. 
For this purpose, a syntax known as CRON is used and five items (Minute, Hour, Day of the Month, Month and Day of the week) correspond to it each time in the configurator.
1

By each job it is also possible to set whether it should be launched immediately after the start of the application (server) or by ticking the item “Run immediately”.
run immediately

Regenerate Repository Tree Job

Regenerate Repository Tree Job EA Infoport Team Thu, 07/16/2020 - 14:21

Regenerate Repository Tree Job


This job is designed for the periodical update of the repository tree, independently of the users.
When launched, it strolls gradually through the currently cached tree and compares it to the state in the database. 
If it does not detect any differences, it leaves the tree branches untouched. 
But if it detects any change at some level of immersion (added / taken out / changed artefact), it takes all the deeper immersed artefacts out of the cache and restores them from the database. 
This restoration progresses into the depth of immersion given by the parameter „Maximum Cache Deep” from the section „Prefetch Repository Cache”.

The suitable timing is a moment in which the users work minimally with the programme, i.e. during night hours and after (possible) automatic synchronisations of the models on the database level with some external software.

Regenerate Image

Regenerate Image EA Infoport Team Fri, 08/28/2020 - 15:10

Regenerate Image

The chart images are generated commonly in two ways. 
The user may either display a detail of the chart or the jobs in the background „Regenerate Existing Image" and „Regenerate Missing Image". 
After it has been generated, the image is saved into the disc cache, and upon a requirement from (any) user, it is displayed from the disc again. 
However, the images also get outdated when they are modified or changed as metadata by someone. 
If a user displays the image of the chart that has been modified recently, the system will recognise it. 
It displays the original outdated image from the disc cache, and it starts to regenerate the chart. 
But it takes some time (higher value of seconds typically), and it delays the user.
Therefore, there are two jobs that try to prevent it. They search for the outdated or still non-generated charts, and they regenerate them.

Regenerate Existing Image Job

Regenerate Existing Image Job EA Infoport Team Thu, 07/16/2020 - 14:17

Regenerate Existing Image Job

This job has to regenerate the formerly created chart images. 
It recognises whether the chart has been modified since it was last created, and it possibly lets it be created and saved into the disc cache again. 
The word „Existing” in the name of this job means that the work of this job relates exclusively to the charts that already have “some” image in the disc cache. (The non-existing images are handled by Regenerate Missing Image”.)

The switch Only By Tree Cache” decides whether the regeneration focuses only on the images from the disc that belong to the charts that are loaded into the memory cache of the tree (see Prefetch Repository Cache”). If this switch is not ticked, the job ensures the timeliness of all images saved in the disc cache, regardless of the current state of the tree.
only be tree cache

The switch Check Modified Date” and Check Hash Matching” serves for specifying the method of what programme it will use to detect whether an image is outdated.

The first one Check Modified Date” means that the time stamp of the file is checked in comparison with the time stamp in the database. 
This is very fast, but the reliability is somewhere around 90%.
It is given by the fact that not all modifications in the chart update this time stamp. (This is directly the property of the Enterprise Architect programme.)

Check modifite date

The other switch Check Hash Matching” decides that, for the control, the calculation of the so-called hash of all metadata that influence the visual aspect of the image will be used. 
This method is 100% responsible but it is time-consuming.
check hash matching

Both switches may be combined”. 
If we tick neither of the switches, we tell the programme not to control anything and to regenerate directly all the charts. 
The last option is to tick the both switches, due to this, the programme first controls the date of the modification and then the hash. 
The recommended settings are to have only Check Modified Date” ticked, taking into account that the probability of non-regenerating the outdated chart does not mean such a serious complication. 
In case the user displays an (outdated) chart image, the hash is controlled at any instance, and the programme reacts to the untimeliness by its regeneration and displaying the refreshed image follows.

The last parameter of this job is Gap Milliseconds”. 
It is an interval between the generation acts of individual chart images. 
These are not typically generated one after another, but a time gap is kept here. 
Its purpose is to also enable processing the user’s requirement for generating an image without undue delay. 
The default value of this parameter is 5000 (i.e. 5s), but if we know that during the period of regeneration the users will stay inactive, this parameter can be significantly reduced or set to 0.
gap

Regenerate Missing Image Job

Regenerate Missing Image Job EA Infoport Team Thu, 07/16/2020 - 14:16

Regenerate Missing Image Job

This job has to add generation of the not-yet-created chart images and save them to the disc cache. 
It does not work with the already created and in-cache-saved images in any way, not even if they were outdated. (For this purpose, there is „Regenerate Existing Image”.) 

The switch „Only By Tree Cache” decides whether the generation focuses only on the charts loaded in the memory cache of the tree (see „Prefetch Repository Cache”). 
If this switch is not ticked, the job ensures generating of all chart images that are included in the complete tree.
only be tree cache

The last parameter of this job is „Gap Milliseconds”.
It is an interval between the generation acts of individual chart images. 
These are not typically generated one after another, but a time gap is kept here. 
Its purpose is to also enable processing the user’s requirement for generating an image without undue delay. 
The default value of this parameter is 5000 (i.e. 5s), but if we know that during the period of regeneration the users will stay inactive, this parameter can be significantly reduced or set to 0.
gap

RefreshLocksJob

Refresh Locks Job EA Infoport Team Thu, 07/16/2020 - 14:22

Refresh Locks Job

Job synchronises the locks that have been set in Enterprise Architect

For the correct (current) display of the tree repository, it is necessary to know which locks are set on which artefact.
Therefore, in order for the tree to be rendered quickly, it is not possible to query the database each time it is displayed, but it is necessary to have them cached in memory. 
That is the role of this job. 
The recommended activation interval is every tenth minute (i.e. the value “*/10" is set in the CRON item Minute).

The locks cached in this way are used to decorate the tree and to display the editing buttons in detail.
Before the actual editing of an artefact, however, a check is always made to the database to see if a lock has been added. 
This guarantees that even if cached information about a non-existent lock is “obsolete”, there will be no unauthorised editing of the artefact. 
However, if there is outdated information in the cache about the presence of a lock (which has been removed in the meantime), then the icon for editing is not displayed. 
If this occurs, a user refreshment of a lock can be made. This is done by starting the package recovery by right-clicking in the parent package in the tree repository.
In addition to restoring the relevant part of the tree, the locks are also restored.
 

CleanDcomJob

Clean Dcom Job EA Infoport Team Thu, 07/16/2020 - 14:19

Clean Dcom Job

This Job is used to remove redundant (typically non-functional) DCOMs from the operating system’s memory. 

DCOM is an intermediary in communication between EAInfoport and Enterprise Architect. 
DCOM is most often used to generate diagram images but also for some active operations (such as creating and deleting an artefact). 
At least one DCOM is required to connect to each repository.

Sometimes an error occurs in DCOM, and it is then ineligible for further communication. 
If this happens, a new instance of DCOM is created immediately in the memory (and transparently for the user) and it will start to be used. 
However, the original instance remains in memory at that moment. It is only removed by this cleaning job.

The “Max Dcom Per Repository” parameter specifies the maximum number of tolerated DCOMs in the memory per repository. 
This means that the program multiplies this parameter by the number of connected repositories and checks whether the total number of running DCOMs is less than this number. 
The “Max Dcom Per Repository” does not distinguish which DCOM “belongs” to which repository. 
If the limit is exceeded, all instances of DCOM are deleted from memory and the program then re-creates them when needed. 
max DCOM repository

If you run multiple EaInfoport installations on one server (which is possible on different ports), the “Max Dcom Per Repository” parameter must be set with the knowledge that each installation (if this job is active) will count the number of repositories accordingly.

CleaningDiskCacheJob

Cleaning Disk Cache Job EA Infoport Team Thu, 07/16/2020 - 14:07

Cleaning Disk Cache Job

This job is used to clean the disk cache.

Disk cache is a directory on a disk where diagram images are stored so that they can be viewed quickly by users.
Some image files created a long time ago may no longer matter. They take up disk space unnecessarily and can be removed.

The first of two “Safety Gap Seconds” parameters protects the youngest (latest) files from being deleted. 
For example, the default value of 86400 (which is 60*60*24 s) says that files created in the last 24 hours will not be cleaned (deleted), even if their total disk size exceeds the limit (given by the second parameter).
safety gap seconds

The second “Disk Size Limit Bytes” parameter says what is the maximum total size of files on the disk after cleaning. 
The job sorts the image files according to the time they are created and gradually deletes them from the oldest ones until the rest take up less disk space than this limit. 
However, if even too “young” files (according to the first parameter) should be deleted, the deletion will end, and the files will take up more space on the disk.
disk size limit

Between runs of this job, it is not monitored (nor regulated) that the files on the disk do not take up much space.

It is advisable to set the size of the “Disk Size Limit Bytes” parameter so that the image files generated by the “Regenerate Missing Image” just fit into the disk limit. If the size limit is lower than the size of images, there is a constant cyclic (i.e. unnecessary) generation and deletion of the same images. 
If a diagram image is already stored on the disk, then its regeneration (of course, if its model has not been extended) no longer requires additional disk space.
 

Application Configuration

Application Configuration EA Infoport Team Thu, 07/16/2020 - 13:58

Application Configuration

Application Configuration Settings

Application Configuration Settings EA Infoport Team Thu, 07/16/2020 - 13:59

Application Configuration Settings

This chapter describes only the parameters that are typically edited during installation.

Before starting the application, make sure that no application is communicating on port 80.

After starting the application, the Configuration Manager is displayed, which needs to be filled in.

1

2

3

Infoport Connection Settings

Infoport Connection Settings EA Infoport Team Thu, 07/16/2020 - 14:01

Infoport Connection Settings

In this section, we configure the portal's access to the database with its metadata. (We created it in step 3.4.8.) It is necessary to have a prepared database user with permissions for reading/writing/creating DB objects.

If an MSSQL database with integrated security is used, it is not necessary to fill in a UserId or Password. However, it is necessary to have an established user in the database, under which the portal (and therefore also EA) is run.

InfoportConnection_MySql": "Server=127.0.0.1;port=3306;Database=ipInitData;Uid=Admin;Pwd=xxxxx;"

  • DBMS: The parameter name must be the same (InfoportConnection), suffix of this parameter differs according to the used db: _MySQL / _SQLServer / _Oracle / etc..
  • Server: Name or IP address of the server.
  • Port: The port on which the DB is listening (optional parameter).
  • Database: The name of the database in which the portal metadata is stored.
  • Name: The name of the database user.
  • Password: Database user password.
  • Timeout: Time for which the query takes place. In a large database, this may take longer than a minute, so set a minimum of 90 for large databases. ("Timeout":  90)
  • Maximum Dcom Instances: 2 – MaximumDcomInstances indicates the maximum number of DCOMs for each running EaInfoport server. The default value (if nothing specified) is 2. If a user does not wish to terminate DCOMs, then he/she should set a very high number (for example 99). If the maximum number of DCOMs is exceeded, the server will kill them all and start a fresh one. The check is done at startup, as well as at regular intervals set in Background / Seconds.
  • If DCOM is turned off in the task manager, EAInfoportT3 will turn it back on in a moment

1

Fill in the database schema (this is not the Enterprise Architect repository schema, but the schema for EAInfoport metadata). The database schema must be empty and only for EAInfoportT3 purposes. After filling in the appropriate tab, the user clicks the "Check" button, if the tab lights up red, any errors need to be corrected. If it lights up green, the tab has been filled in correctly.

Running EaInfoportT3

Running EaInfoportT3 EA Infoport Team Thu, 07/16/2020 - 14:23

Running EaInfoportT3

In the EAInfoportT3 directory, run the EaInfoportT3.exe file.
After the application starts (it may take a few minutes), verify the correct operation of the application by entering the url set above in the browser.
Follow this procedure and run EaInfoportT3.exe. Running multiple instances of the portal: Running multiple instances of the portal on one server can be set by simply copying the EAInfoportT3 folder, configuring each folder according to this procedure and running EaInfoportT3.exe

Create and Edit

Create and Edit EA Infoport Team Wed, 09/01/2021 - 09:58

Create and Edit

edit

Appearance

Appearance EA Infoport Team Wed, 09/01/2021 - 10:01

Appearance

Just fill in the title, description and choose a color. (Name is a required field).

Appearance

This configuration is reflected when switching between repositories or in repository lists.

2

 

EA Shortcut

EA Shortcut EA Infoport Team Wed, 09/01/2021 - 10:02

EA Shortcut

To create a shortcut, you must have Enterprise Architect installed and be connected to the EA repository.

If we have managed to connect to the repository and have an open project, click on the EA icon in the upper left corner ea

ea1

Click on Save as Shortcut... select the path and click OK.
(we recommend saving the path to your history clipboard using ctrl+c and opening the file beforehand to see if it redirects you to the repository)

project

 

Now, in the EA Shortcut configuration, enter the path to the EAP file and the user with the password to the repository, if security is enabled. The generate button is optional.

EA Shortcut

(If your EA database is MySQL or PostgreSQL, you use ODBC to connect to EA. You can use the blue bordered button to generate a connection string to your database).

 

EA Database

EA Database Barbora Dřevojánková Wed, 09/01/2021 - 10:03

EA Database

Choose the type of database in which the EAP is connected using EA and write its connection string.

database

If you have filled in all the details, you can select the test connection and save button.

conn

save

 

Examples of Connection Strings

Examples of Connection Strings EA Infoport Team Thu, 07/16/2020 - 13:16

Examples of Connection Strings

Oracle:

  • "InfoportConnection_Oracle": "DATA SOURCE=(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1536)))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=dedicated)));User Id=ip;Password=test;",

MS SQL:

  • "InfoportConnection_SqlServer": "Server=127.0.0.1;Database=eainfoport;User id=****;Password=***;",

 MS SQL trusted connection:

If the database has integrated security for the domain, use the connection string below:

  • "Server=XXXXX;Database=YYYYY;Trusted_Connection=True"

MySQL:

  • "InfoportConnection_MySql": "Server=127.0.0.1;port=3306;Database=test_eainfoportt3;Uid=EaInfoportT3;Pwd=info;"

 MariaDB:

  • "InfoportConnection_MySql": "Server=127.0.0.1;port=3306;Database=test_eainfoportt3;Uid=EaInfoportT3;Pwd=info;"

Known Startup Errors

Known Startup Errors EA Infoport Team Thu, 07/16/2020 - 14:24

Known Startup Errors

The following errors may occur when running EaInfoportT3:

  • Untrusted zip error

známé chyby

If a user sees this error after running EaInfoportT3.exe, either in the log or in the console, it means that the server considers the downloaded EaInfoportT3_Delivery.zip to be untrusted. The repair will be performed as shown below.

1

The user right-clicks on EaInfoportT3_Delivery.zip and calls up the properties. In the “General” > Security tab then click on the “Unblock”  button and unzip the corresponding .zip again – the error should be resolved.
 

  • Another error is related to the EaInfoportT3 database language – it must be created in utf8_general_ci

If it is created in a wrong language, an error containing the following characters is displayed in the console: Incorrect string value: '\xC5\x98\xC3\xA1de...'

  • FIPSPolicy error

Error form: [ERR] An unhandled exception has occurred while executing the request.

System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation. ---> System.InvalidOperationException: This implementation is not part of the Windows Platform FIPS validated cryptographic algorithms.

at System.Security.Cryptography.MD5CryptoServiceProvider..ctor()

Fix: The following lines must be added to EaInfoportT3.exe.config.

<configuration>                                                           
    <runtime>
        <!-- below tag will disable security policy checking for FIPS -->
        <enforceFIPSPolicy enabled="false"/>
    </runtime>
</configuration>