Changes

{{Under construction | This page is under construction}}The IMSMA Staging Area Generator is a tool that allows to create creates a staging area from an IMSMA {{IMSMANG}} database. It is thus part of the {{IMSMANG}} tool set, but not directly integrated into included in the {{IMSMANG}} installation package. It IMSMA Staging Area Generator thus needs to be installed separately. Please contact your country focal point [[Information Management Team | GICHD IM advisor]] in order to get the latest installation package.

{{Note | The Staging Area Generator can only be used with {{IMSMANG}} 6.0 and abovehigher.}}==Basic Principles==__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.

== Installing When creating the IMSMA Staging Area Generator==__NOEDITSECTION__<ol><li>To install the staging area generator (SAG) double-click on database with 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.pngUsing Staging Area Generator |center|200pxStaging Area Generator]]</li><li>Navigate the Installation panels of the graphical installer as described belowis possible to choose:<ol>* which language to use<li>On the Welcome screen, click '''Next'''.</li><li>On the Infromation screen, click '''Next'''.</li><li>We strongly recommend * which Country structure name to use (main or any of the default installation path for the Staging Area Generator. '''Click Next'''.</li>alternative names)<li>If the target folder (C:\IMSMAETLTool) does not already exist a message will * if PostGIS geodata should be shown, click '''OK'''. </li>created<li>In the packages selection panel, click '''Next'''.</li>* which projection to use<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_Icondo data post-processing.png]]<br />

==Using the IMSMA Staging Area Generator==__NOEDITSECTION__===Basic Principles===__NOEDITSECTION__===Where It is easy to use it===__NOEDITSECTION__===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 Scheduling the Staging Area Generator user interface'''|-| width="200pt" | '''Section''' | width="800pt" creation | '''Description'''|-| align="left" | '''1 - Source Database''' | align="left" | This section defines schedule 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. 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''). |-| align="left" | '''3 - Post Processing SQL Scripts (optional)''' | align="left" | 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|-| align="left" | '''4 - Additional Options''' | align="left" |* '''Conversion Language:'''* '''Gazetteer Seq No:'''* '''Do Geodata:'''* '''Target SRID:'''|-|}[[Image:Staging_Area_Generator_GUI_options.png|centercreation]] ==Scheduling of the Staging Area creation==__NOEDITSECTION__database.