====== Installation and configuration of a Vigilens station ======
===== Use Case =====

This is the installation on an individual workstation or on an application server allowing to use Vigilens Designer and the other Windows applications of the Vigilens suite.

===== Minimum Technical Requirements =====
==== Operating System ====

Windows 32 or 64 bits.

  * Windows Server 2008
  * Windows 7
  * Windows 8
  * Windows Server 2012
  * Windows 10

==== Hardware ====

Feedback from our installed base shows that a configuration with **4 vCPU** and **8 GB RAM** allows a satisfactory use of Vigilens.

==== Disk space ====
  * minimum of 0.5 GB for the installation of Vigilens
  * 20 GB recommended for a classic use of the software (queries, results files, ...)

==== ODBC drivers / OCI ====

The user workstation must first have the ODBC or OCI drivers corresponding to the databases to be requested. We recommend the use of the drivers provided by the editors of the corresponding databases (only these are validated and covered by our support).

<WRAP round important>
The application uses the 32-bit version of ODBC. There is a button in the AdminTool to access the correct version of the ODBC settings, see [[:en:v8_0_0:admintool:menus:accueil:application:start#odbc|the dedicated section of the AdminTool]].</WRAP>

===== Installation =====
Start the installation by double-clicking on the provided executable file.

==== Select a language ====
This is the language used during installation. 

{{:en:v8_0_0:installation:pasted:20210201-150154.png?nolink&300}}

==== Select an installation directory ====
{{:en:v8_0_0:installation:pasted:20210201-150257.png?nolink&400}}

<WRAP round alert>
It is not recommended to install Vigilens under "Program Files" or "Program Files (x86)" because this can cause problems when using some ODBC drivers.
</WRAP>

<WRAP round important>
This screen only appears the first time a workstation is installed. In the event of any reinstallations, the previous installation folder is kept without the selection screen appearing. In order to change the installation folder, the application must first be uninstalled (from the Windows control panel).
</WRAP>

==== Select components to be installed ====
{{:en:v8_0_0:installation:pasted:20210201-150921.png?nolink&400}}

[[:en:start#vigilens_tools_suite|the Vigilens Tools Suite is made of 6 Windows applications.]]

<WRAP round alert>
It is necessary to install the AdminTool and LogManage applications on at least one workstation.
</WRAP>

==== Summary ====
{{:en:v8_0_0:installation:pasted:20210201-150952.png?nolink&400}}

===== Setup =====
==== Define shared folder ====
The shared folder must be created in windows beforehand, shared and accessible to all Windows profiles using the Vigilens application. It is defined the first time the AdminTool application is launched.

{{:v8_0_0:installation:pasted:20200706-151408.png?nolink&300}}

The dialog box allows you to enter this directory. If it is located on another machine (server accessible by the network, for example), it is preferable to indicate it in a relative way ''\\server\path\''. It will contain the following elements:

  * A "Users.EVIDENS-Security" file containing the definition of groups, users and their rights and restrictions. This file is created at the first launch of the AdminTool application. It must be accessible in reading and writing by all users.
  * The "LicenseGen.evs" and "LicenseGen.dat" files related to the global license.
  * A "DS" directory containing information on the shared data sources.
  * A "ES" directory containing information about any shared data sources used for data export.
  * An "OW.EVIDENS-Parameter" file containing the possible parameters related to the data sources corresponding to JD Edwards databases ("EnterpriseOne / OneWorld" or "World / WorldSoftware"). This file is created (if needed) by the AdminTool application. It must be readable by all users.
  * A "CS" directory corresponding to the shared queries tree.
  * A "Login" directory containing the files used to manage connections to Vigilens.
  * A "Log" directory containing the trace files generated by Vigilens.

==== Changing the administrator password ====
The only account allowing access to the AdminTool administration application is the "Admin" profile. This profile is not counted in the number of subscribed licenses.

At installation, its password is blank. For security reasons, the user definition file is only considered valid when the "Admin" profile has a password entered. See [[:en:v8_0_0:admintool:menus:gestion:start#global|changing the password in the AdminTool]].

==== Definition of shared data sources ====
See [[:en:v8_0_0:admintool:menus:accueil:application:start#Databases|Admintool dedicated menu]].

==== Case of JDEdwards data sources ====

In the case of JD Edwards databases (Database type), in order to benefit from the advanced functionalities linked to this source (automatic retrieval of table and field descriptions, use of formats defined at the data dictionary level, taking into account UDC values...), it is necessary to define additional parameters.

See [[:en:v8_0_0:admintool:menus:accueil:enterpriseone:start|Admintool dedicated menu]].


==== Obtaining the global license ====

You cannot use the AdminTool application to manage user profiles (and consequently the Vigilens application) until you have obtained a global license.

See [[:en:v8_0_0:admintool:menus:accueil:start#licence|Admintool dedicated menu]].

You can now create groups, users and use Vigilens

==== Import shared databases ====

See [[:en:v8_0_0:designer:menus:personnalisation:start#database|Vigilens Designer dedicated menu]].


===== Update =====

<WRAP round alert>
When migrating to a new server, be careful to change the user work folders so that they do not point to the same physical folders, otherwise there will be corruption of work in progress on the old version. See the menu ''Change user work folder'' in [[en:v8_0_0:admintool:menus:gestion:start|menu de gestion utilisateurs de l'AdminTool]]].
</WRAP>



==== Major version change ====

If the update makes a major version change (for example: update from a 6.x.x to a 7.x.x version) you must uninstall the previous version and then install the new one.

==== Minor version change ====
In case you stay on the same major version (for example: update from version 8.0.x to 8.1.x) just run the installation program as described in paragraph [[v8_0_0_0:installation:installationposte#execution_of_the_installation|execution of the installation]]. 

<WRAP round important> 
Attention special situation between version 7.5.0 and the following ones\\\ 
The installation program has changed format, so you must uninstall the old version and then install the new one. 
 </WRAP>

===== Windows Security Management =====

To avoid any problem, it is strongly recommended that users (Windows) accessing Vigilens have total control over the following folders:

  * Vigilens installation directory 
  * the shared directory
  * their subdirectories

In addition, these users must have **full control** access to the following registry keys and their subkeys :

  * For 32-bit machines
    * ''HKEY_CURRENT_USER\SOFTWARE\EVIDENS''
    * ''HKEY_LOCAL_MACHINE\SOFTWARE\EVIDENS''
  * For 64-bit machines
    * ''HKEY_CURRENT_USER\SOFTWARE\WOW6432Node\EVIDENS''
    * ''HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\EVIDENS''

Users who can import databases (not Oracle) from Vigilens, must also have full control over the following key (and subkeys):

  * For 32-bit machines: ''HKEY_LOCAL_MACHINE\SOFTWARE\ODBC.INI''
  * For 64-bit machines: ''HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\ODBC.INI''