Difference between revisions of "Patch Installation Guide"

From IMSMA Wiki
Jump to: navigation, search
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{TOC right}}
 
{{TOC right}}
  
{{Note| Patch installation of {{IMSMANG}} v 6.0 is '''ONLY''' possible to use when {{IMSMANG}} v 6.0 is already installed and the database is '''ALREADY''' upgraded to v 6.0.}}
+
{{Note| Patch installation of {{IMSMANG}} v 6.0 is '''ONLY''' possible to use when {{IMSMANG}} v 6.0 is already installed.}}
  
[[Image:PatchInstallationGuideStep1.png|center|500px|''Running the IMSMA Patch Installer'']]
+
==Part 1. Preparations==__NOEDITSECTION__
==Part 1. Preparations==
+
{{Warning| Read this section carefully because the patch installation will change configuration files.}}
 +
 
 +
[[Image:PatchInstallationGuideStep1.png|center|500px|''Preparation before running the IMSMA Patch Installer'']]
  
 
<ol>
 
<ol>
 
<li>Stop the {{IMSMANG}} client and server.
 
<li>Stop the {{IMSMANG}} client and server.
 +
<li>If you have made any changes to the [[Install IMSMANG Version 6#Part 5 Type of configuration| client and/or server configuration]], note them down.
 
<li>Take a backup of the {{IMSMANG}} database.
 
<li>Take a backup of the {{IMSMANG}} database.
<li>Stop the TrayLauncher.
+
<li>Exit the IMSMA Control Centre.
<li>Take copy of PostGreSQL configuration file C:\IMSMAng\pgsql\data\pg_hba.conf.
+
<li>Take a copy of the two main PostGreSQL configuration files ''C:\IMSMAng\pgsql\data\pg_hba.conf'' and ''C:\IMSMAng\pgsql\data\postgresql.conf''. These contain any custom configurations, e.g.  allowing remote database access, etc.
 +
<li>If you have set up [[PgSQL_Replication|SQL replication]], you also should take a copy of ''recovery.conf'' on the standby server, as well as the above mentioned configuration files on '''both the master and the standby server'''.
 
</ol>
 
</ol>
  
==Part 2. Run the {{IMSMANG}} Installer==
+
==Part 2. Run the {{IMSMANG}} Patch Installer==__NOEDITSECTION__
 +
[[Image:PatchInstallationGuideStep2.png|center|500px|''Running the IMSMA Patch Installer'']]
 +
 
 
[[Image:Cmd NG.png|center|400px]]
 
[[Image:Cmd NG.png|center|400px]]
 
<ol>
 
<ol>
Line 20: Line 26:
  
 
[[Image:Graphic NG.png|center|200px]]</li>
 
[[Image:Graphic NG.png|center|200px]]</li>
 +
 +
<li>On the Language Selection window, select the language you want to use during installation and click '''OK'''.
  
 
[[Image:1st panel NG.png|center|400px]]</li>
 
[[Image:1st panel NG.png|center|400px]]</li>
Line 38: Line 46:
 
</ol>
 
</ol>
  
==Part 3. Set Permissions for the Tray Launcher==
+
==Part 3. Set Permissions for the IMSMA Control Centre==__NOEDITSECTION__
 
+
[[Image:PatchInstallationGuideStep3.png|center|500px|''Setting IMSMA Control Centre Permissions'']]
[[Image:PatchInstallationGuideStep2.png|center|500px|''Setting Tray Launcher Permissions'']]
 
 
<div align="center">
 
<div align="center">
 
</div>
 
</div>
Line 47: Line 54:
 
<li>In the IMSMA Tray Launcher Properties window, select the '''Shortcut''' tab, then click '''Advanced'''. </li>
 
<li>In the IMSMA Tray Launcher Properties window, select the '''Shortcut''' tab, then click '''Advanced'''. </li>
 
<li>In the Advanced Properties window, check the '''Run as administrator''' checkbox, then click '''OK'''. It is important to use ''Run as administrator'' the first time {{IMSMANG}} is started since other installation programs will be triggered. Depending on how much user permissions are limited, it might be better to not Run as administrator.</li>
 
<li>In the Advanced Properties window, check the '''Run as administrator''' checkbox, then click '''OK'''. It is important to use ''Run as administrator'' the first time {{IMSMANG}} is started since other installation programs will be triggered. Depending on how much user permissions are limited, it might be better to not Run as administrator.</li>
<li>Back in the IMSMA Tray Launcher Properties window, click '''OK'''. It is important to set this property since you will start other applications with the Tray Launcher.</li></ol>
+
<li>Back in the IMSMA Tray Launcher Properties window, click '''OK'''. It is important to set this property since you will start other applications with the Tray Launcher.</li>
 
</ol>
 
</ol>
==Part 4. PostGreSQL configuration==
+
==Part 4. PostGreSQL configuration==__NOEDITSECTION__
If there have been any changes done in the PostGreSQL configuration file C:\IMSMAng\pgsql\data\pg_hba.conf, they have to be re-applied.  
+
[[Image:PatchInstallationGuideStep4.png|center|500px|''PostGreSQL configuration'']]
 +
 
 +
If there have been any changes done in the PostGreSQL configuration files
 +
# C:\IMSMAng\pgsql\data\pg_hba.conf
 +
# C:\IMSMAng\pgsql\data\postgresql.conf
 +
# C:\IMSMAng\pgsql\data\recovery.conf
 +
they have to be '''re-applied'''.
 +
 
 +
{{Note| There might have been changes of the files in the patch so all customisation needs to be '''re-applied'''. Note that if you have [[PgSQL_Replication|SQL replication]] set up, the right configuration files need to be restored on the master and the standby server, and the initial backup procedure from the master to the standby needs to be applied. }}
  
{{Note¦ There might have changes in the patch so all customisation of pg_hba.conf needs to be '''re-applied'''.}}
+
==Part 5. Verification of the client/server configuration==__NOEDITSECTION__
 +
[[Image:PatchInstallationGuideStep5.png|center|500px|''Verification of the client/server configuration'']]
 +
 
 +
The patch installation may also update other configurations than the PostGreSQL so the client and/or server configurations should be verified before continuing.
 +
<ol>
 +
<li>The file ''C:\IMSMAng\trayLauncher\TrayLauncher.properties'' where the memory allocation is set, should not changed by the patch installation.<br/><br/>
 +
[[Image:ClientConfig.png|center|500px]]
 +
<div align="center">
 +
</div>
  
 +
<li>The client configuration should not changed by the patch installation.
 +
<li> The file ''c:\imsmang\server\imsmaserver\conf\GisService.properties'' needs to be double-checked.
 +
</ol>
  
4A. This always applies to [[Windows8]].
+
==Part 6. Database Update==__NOEDITSECTION__
4B. Replication.
+
[[Image:PatchInstallationGuideStep6.png|center|500px|''Database update'']]
  
==Part 5. Database Update==
 
 
<ol>
 
<ol>
 
<li>On your desktop, double-click the IMSMA Tray Launcher icon.
 
<li>On your desktop, double-click the IMSMA Tray Launcher icon.
[[Image:DBupdate.png|center|400px]]</li>
+
<br/>
 +
 
 +
[[Image:DBupdate1.png|center|400px]]</li>
 +
 
 +
<li>A message will be displayed notifying you if there are any database changes that needs to be applied. Click '''OK''' to begin the process(es).</li>
 +
 
 +
 
 +
[[Image:DBupdate2.png|center|600px]]</li>
 +
 
 +
<li>A SQL Upgrade window will display and the progress will be shown in the lower part of the window.
  
  
 +
[[Image:DBupdate3.png|center|400px]]</li>
 +
 +
 +
<li>When the update process is done a message will be displayed. Click '''OK'''.
  
<li>A message will display notifying you if there are any database changes that needs to be applied. Click '''OK''' to begin the process(es).</li>
 
 
</ol>
 
</ol>
  
 
+
{{NavBox IMSMA NG Administration}}
{{NavBox Getting started with IMSMA}}
 
  
 
[[Category:NAA]]
 
[[Category:NAA]]
 
[[Category:NoPublic]]
 

Latest revision as of 12:09, 4 May 2021

Note.jpg Patch installation of IMSMANG v 6.0 is ONLY possible to use when IMSMANG v 6.0 is already installed.

Part 1. Preparations

Warning.jpg Read this section carefully because the patch installation will change configuration files.
Preparation before running the IMSMA Patch Installer
  1. Stop the IMSMANG client and server.
  2. If you have made any changes to the client and/or server configuration, note them down.
  3. Take a backup of the IMSMANG database.
  4. Exit the IMSMA Control Centre.
  5. Take a copy of the two main PostGreSQL configuration files C:\IMSMAng\pgsql\data\pg_hba.conf and C:\IMSMAng\pgsql\data\postgresql.conf. These contain any custom configurations, e.g. allowing remote database access, etc.
  6. If you have set up SQL replication, you also should take a copy of recovery.conf on the standby server, as well as the above mentioned configuration files on both the master and the standby server.

Part 2. Run the IMSMANG Patch Installer

Running the IMSMA Patch Installer
Cmd NG.png
  1. Double-click the Install_IMSMA.exe file in the patch installation package.
  2. When the command window displays, follow the instructions.
    Graphic NG.png
  3. On the Language Selection window, select the language you want to use during installation and click OK.
    1st panel NG.png
  4. Navigate the Installation panels of the graphical installer as described below:
    1. In the Welcome panel, click Next.
    2. Select the I accept the terms of this license agreement option, and click Next.
    3. In the packages selection panel, click Next.
    4. Wait for the installation progress bar to finish, then click Next.
    5. When the Setup Shortcuts panel displays, click Next.
    6. When the installation has completed successfully, click Done.
      Note.jpg When the graphical installer has finished the focus goes back to the command window and the next steps of the installation continue so please do not close the command window.
  5. When prompted by the command window, press any key on the keyboard to continue.

Part 3. Set Permissions for the IMSMA Control Centre

Setting IMSMA Control Centre Permissions
  1. On your desktop, right-click the IMSMA Tray Launcher icon and select the Properties option.
  2. In the IMSMA Tray Launcher Properties window, select the Shortcut tab, then click Advanced.
  3. In the Advanced Properties window, check the Run as administrator checkbox, then click OK. It is important to use Run as administrator the first time IMSMANG is started since other installation programs will be triggered. Depending on how much user permissions are limited, it might be better to not Run as administrator.
  4. Back in the IMSMA Tray Launcher Properties window, click OK. It is important to set this property since you will start other applications with the Tray Launcher.

Part 4. PostGreSQL configuration

PostGreSQL configuration

If there have been any changes done in the PostGreSQL configuration files

  1. C:\IMSMAng\pgsql\data\pg_hba.conf
  2. C:\IMSMAng\pgsql\data\postgresql.conf
  3. C:\IMSMAng\pgsql\data\recovery.conf

they have to be re-applied.

Note.jpg There might have been changes of the files in the patch so all customisation needs to be re-applied. Note that if you have SQL replication set up, the right configuration files need to be restored on the master and the standby server, and the initial backup procedure from the master to the standby needs to be applied.

Part 5. Verification of the client/server configuration

Verification of the client/server configuration

The patch installation may also update other configurations than the PostGreSQL so the client and/or server configurations should be verified before continuing.

  1. The file C:\IMSMAng\trayLauncher\TrayLauncher.properties where the memory allocation is set, should not changed by the patch installation.

    ClientConfig.png
  2. The client configuration should not changed by the patch installation.
  3. The file c:\imsmang\server\imsmaserver\conf\GisService.properties needs to be double-checked.

Part 6. Database Update

Database update
  1. On your desktop, double-click the IMSMA Tray Launcher icon.
    DBupdate1.png
  2. A message will be displayed notifying you if there are any database changes that needs to be applied. Click OK to begin the process(es).

  3. DBupdate2.png
  4. A SQL Upgrade window will display and the progress will be shown in the lower part of the window.
    DBupdate3.png

  5. When the update process is done a message will be displayed. Click OK.