Difference between revisions of "Staging Area Generator"

From IMSMA Wiki
Jump to: navigation, search
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{TOC right}}
 
{{TOC right}}
{{Under construction | This page is under construction}}
+
The IMSMA Staging Area Generator is a tool that creates a staging area from an {{IMSMANG}} database. It is thus part of the {{IMSMANG}} tool set, but not included in the {{IMSMANG}} installation package. IMSMA Staging Area Generator thus needs to be installed separately. Please contact your [[Information Management Team | GICHD IM advisor]] in order to get the latest installation package.
The IMSMA Staging Area Generator is a tool that allows to create a staging area from an IMSMA database. It is thus part of the {{IMSMANG}} tool set, but not directly integrated into the {{IMSMANG}} installation package. It thus needs to be installed separately. Please contact your country focal point in order to get the latest installation package.
 
== Installing the IMSMA Staging Area Generator==__NOEDITSECTION__
 
<ol>
 
<li>To install the staging area generator (SAG) double-click on the '''etl.exe''' file..</li>
 
<li>The graphical installer then starts. On the first screen, choose the language you would like to use for the installation and click '''OK'''.
 
[[Image:SAGInstallStep1.png|center|200px]]</li>
 
<li>Navigate the Installation panels of the graphical installer as described below:
 
<ol>
 
<li>On the Welcome screen, click '''Next'''.</li>
 
<li>On the Infromation screen, click '''Next'''.</li>
 
<li>We strongly recommend to use the default installation path for the Staging Area Generator. '''Click Next'''.</li>
 
<li>If the target folder (C:\IMSMAETLTool) does not already exist a message will be shown, click '''OK'''. </li>
 
<li>In the packages selection panel, click '''Next'''.</li>
 
<li>Wait for the installation progress bar to finish, then click '''Next'''.</li>
 
<li>When the Setup Shortcuts panel displays, click '''Next'''.</li>
 
<li>When the installation has completed successfully, click '''Done'''.</li>
 
</li>
 
</ol>
 
</ol>
 
After the installation, the following menu entry will be visible in Start &rarr; All Programs &rarr; IMSMA:
 
[[File:Staging_Area_Generator_Icon.png]]<br />
 
  
==Using the IMSMA Staging Area Generator==__NOEDITSECTION__
+
{{Note | The Staging Area Generator can only be used with {{IMSMANG}} 6.0 and higher.}}
===Basic Principles===__NOEDITSECTION__
+
==Basic Principles==__NOEDITSECTION__
===Where to use it===__NOEDITSECTION__
+
The Staging Area Generator takes an {{IMSMANG}} database as input and outputs a staging area database, i.e. a flattened version of the IMSMA database, containing only '''approved''' data. The structure of the staging area and a details on the data it contains can be found on the [[Staging Area Database| IMSMA Staging Area Database]] page.
===The Staging Area Generator Graphical User Interface===__NOEDITSECTION__
 
To start the Staging Area Generator, click on the Staging Area Generator Icon in Start &rarr; All Programs &rarr; IMSMA. This will open the following graphical user interface.
 
[[Image:Staging_Area_Generator_GUI.png|center]]<br />
 
{| class="wikitable" width="1000"
 
|-
 
| align="center" colspan="2" | '''Sections in the Staging Area Generator user interface'''
 
|-
 
| width="200pt" | '''Section'''
 
| width="800pt" | '''Description'''
 
|-
 
| align="left" | '''1 - Source Database'''
 
| align="left" | This section defines the connection of the source database, i.e. the {{IMSMANG}} database from which a staging area should be generated. If the source and the target databases should be on the same server, the default connection parameters can be kept. If the staging area is generated on another server, then the IP address of the source server hosting the {{IMSMANG}} database has to be provided in the '''Host''' field. Remember to update the password in the '''Password''' field if you have changed the default imsma password on your {{IMSMANG}} installation.
 
|-
 
| align="left" | '''2 - Target Database'''
 
| align="left" | This section defined the connection to the target database, i.e. the staging area database to be created. The parameters to be provided are the following:
 
* '''Host:''' since the SAG tool has to be run on the target server, the value for this field should always be '''localhost'''
 
* '''Port:''' port of your target Postgres database server installation - the default is 5432 (which is also the port on which IMSMA is running on the source)
 
* '''Database:''' this is the name of the staging area database to be created. You can specify any name here, using '''lower-case alphanumeric characters and underscores'''. If a database with the provided name '''does not yet exist''', the SAG tool will create a database with that name on the target database server. If a database with the provided name '''already exists''', the content will be '''dropped''' and '''recreated''' by the SAG tool. If, for any reason, the database cannot be created, an error message will be displayed. Contact your country focal point if you are unsure how to solve that.
 
* '''User:''' this is the username of the database user that should be the '''owner''' of the staging area database.
 
* '''Password:'''
 
* '''Postgres User:'''
 
* '''Postgres Password:'''
 
|-
 
| align="left" | '''3 - Post Processing SQL Scripts'''
 
| align="left" | desc
 
|-
 
| align="left" | '''4 - Additional Options'''
 
| align="left" |
 
* '''Conversion Language:'''
 
* '''Gazetteer Seq No:'''
 
* '''Do Geodata:'''
 
* '''Target SRID:'''
 
|-
 
|}
 
[[Image:Staging_Area_Generator_GUI_options.png|center]]
 
  
==Scheduling the Staging Area creation==__NOEDITSECTION__
+
When creating the Staging Area database with the [[Using Staging Area Generator | Staging Area Generator]] is possible to choose:
 +
* which language to use
 +
* which Country structure name to use (main or any of the alternative names)
 +
* if PostGIS geodata should be created
 +
* which projection to use
 +
* to do data post-processing.
 +
 
 +
It is easy to [[Scheduling the Staging Area creation | schedule the creation]] of the Staging Area database.
  
 
{{NavBox Business Intelligence}}
 
{{NavBox Business Intelligence}}
[[Category:VIE]]
+
[[Category:NAA]]

Latest revision as of 21:24, 20 February 2020

The IMSMA Staging Area Generator is a tool that creates a staging area from an IMSMANG database. It is thus part of the IMSMANG tool set, but not included in the IMSMANG installation package. IMSMA Staging Area Generator thus needs to be installed separately. Please contact your GICHD IM advisor in order to get the latest installation package.

Note.jpg The Staging Area Generator can only be used with IMSMANG 6.0 and higher.

Basic Principles

The Staging Area Generator takes an IMSMANG database as input and outputs a staging area database, i.e. a flattened version of the IMSMA database, containing only approved data. The structure of the staging area and a details on the data it contains can be found on the IMSMA Staging Area Database page.

When creating the Staging Area database with the Staging Area Generator is possible to choose:

  • which language to use
  • which Country structure name to use (main or any of the alternative names)
  • if PostGIS geodata should be created
  • which projection to use
  • to do data post-processing.

It is easy to schedule the creation of the Staging Area database.