Difference between revisions of "Staging Area Generator"

From IMSMA Wiki
Jump to: navigation, search
Line 65: Line 65:
 
* A connection to the target database will be attempted - if a database with the specified name does not yet exist, it will be created
 
* A connection to the target database will be attempted - if a database with the specified name does not yet exist, it will be created
 
* Some data will be read from the source database in order to populate the '''Additional Options''' section.
 
* Some data will be read from the source database in order to populate the '''Additional Options''' section.
 +
In case of an error, the related message usually specifies what the exact issue is.
 
|-
 
|-
 
| align="left" | '''4 - Additional Options'''  
 
| align="left" | '''4 - Additional Options'''  
−
| align="left" |
+
| align="left" | This section is only enabled after a successful validation of the connection details.
 
* '''Conversion Language:'''
 
* '''Conversion Language:'''
 
* '''Gazetteer Seq No:'''
 
* '''Gazetteer Seq No:'''
−
* '''Do Geodata:'''
+
* '''Do Geodata:''' this is a switch to enable/disable the generation of geodata. The staging area can either be created with non-geodata only, or including all the coordinates (points, polylines and polygons), i.e. the data stored in the GEOPOINT, GEOSPATIALINFO and related tables in {{IMSMANG}}. Refer to the section on geodata below for more details.
−
* '''Target SRID:'''
+
* '''Target SRID:''' when generating geodata in the staging area, the data can be re-projected. The Target SRID allows to define the projection. The default, 4326, corresponds to '''WGS 84'''. For a complete list of available projections, issue the following query on an empty staging area (i.e. the one created after clicking on '''Validate Selections'''):
 +
<pre>
 +
select *
 +
from spatial_ref_sys
 +
</pre>
 
|-
 
|-
 
|}
 
|}

Revision as of 06:23, 20 June 2014

Ambox warning blue construction.png This page is under construction

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.

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

Installing the IMSMA Staging Area Generator

  1. To install the staging area generator (SAG) double-click on the etl.exe file..
  2. The graphical installer then starts. On the first screen, choose the language you would like to use for the installation and click OK.
    SAGInstallStep1.png
  3. Navigate the Installation panels of the graphical installer as described below:
    1. On the Welcome screen, click Next.
    2. On the Infromation screen, click Next.
    3. We strongly recommend to use the default installation path for the Staging Area Generator. Click Next.
    4. If the target folder (C:\IMSMAETLTool) does not already exist a message will be shown, click OK.
    5. In the packages selection panel, click Next.
    6. Wait for the installation progress bar to finish, then click Next.
    7. When the Setup Shortcuts panel displays, click Next.
    8. When the installation has completed successfully, click Done.

After the installation, the following menu entry will be visible in Start → All Programs → IMSMA: Staging Area Generator Icon.png

Using the IMSMA Staging Area Generator

Basic Principles

Where to use it

The Staging Area Generator Graphical User Interface

To start the Staging Area Generator, click on the Staging Area Generator Icon in Start → All Programs → IMSMA. This will open the following graphical user interface.

Staging Area Generator GUI.png

Sections in the Staging Area Generator user interface
Section Description
1 - Source Database 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.
2 - Target Database 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. The default is imsma - however, this will only work if the staging area is created on the same database server on which IMSMA is running. On another, independent, database, there might not be any user named imsma. In that case, another, existing, user can be provided, or the database superuser named postgres can be used.
  • Password: password of the above user.
  • Postgres User: the above defined user that was specified as the owner of the staging area database might not have the permissions to actually create the new staging area database. Therefore, a user with enough permissions has to be provided here. The default is postgres, which is the superuser having all necessary permissions.
  • Postgres Password: password of the above user - in case of doubt, leave the default (password).
3 - Post Processing SQL Scripts (optional) In this optional field it is possible to provide the full path and name to a validated SQL file. Whatever is specified inside that file will be executed on the staging area database after its generation. This can be valuable in several use cases, for example:
  • If a staging area with only a subset of the IMSMA data should be generated (in this case the SQL file would include DELETE statements)
  • If sensitive data (e.g. victim names and addresses) should not be transferred to the staging area (in this case the SQL file would include UPDATE statements to set all the victim names and addresses to NULL)
  • If data has to be pre-computed for reporting purposes
  • If additional database views are necessary, also for reporting and analysis purposes

Contact your country focal point for help in developing SQL statements according to specific requirements.

Validate Selections After having provided all required connection details (sections 1 and 2), click on Validate Selections. The following actions will be performed:
  • A connection to the source database will be attempted
  • A connection to the target database will be attempted - if a database with the specified name does not yet exist, it will be created
  • Some data will be read from the source database in order to populate the Additional Options section.

In case of an error, the related message usually specifies what the exact issue is.

4 - Additional Options This section is only enabled after a successful validation of the connection details.
  • Conversion Language:
  • Gazetteer Seq No:
  • Do Geodata: this is a switch to enable/disable the generation of geodata. The staging area can either be created with non-geodata only, or including all the coordinates (points, polylines and polygons), i.e. the data stored in the GEOPOINT, GEOSPATIALINFO and related tables in IMSMANG. Refer to the section on geodata below for more details.
  • Target SRID: when generating geodata in the staging area, the data can be re-projected. The Target SRID allows to define the projection. The default, 4326, corresponds to WGS 84. For a complete list of available projections, issue the following query on an empty staging area (i.e. the one created after clicking on Validate Selections):
select *
from spatial_ref_sys
Staging Area Generator GUI options.png

Scheduling the Staging Area creation

Staging Area Generator
IMSMA Staging Area
Other Reporting Tools
Indicators
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Staging_Area_Generator&oldid=15568"