Changes

Jump to: navigation, search

Understanding Configuration Options

7,196 bytes removed, 16:37, 7 June 2021
no edit summary
{{TOC right}}
__NOEDITSECTION__
==Standalone versus Networked Configuration==To determine the initial configuration of the IMSMA<sup>NG</sup> system, it is important to understand the two ways in which IMSMA<sup>NG</sup> can be set up and the basic architecture of the system. IMSMA<sup>NG</sup> is a client-/server software application designed to run in stand-alone or networked client/server mode. In a stand-alone system, both the IMSMA<sup>NG</sup> client and server are installed on the '''same''' computer. The stand-alone configuration is the simpler type of installation: it requires no additional network equipment or infrastructure and is easy to maintain.
{| class="wikitable"
|+ Comparison of Standalone Stand-alone and Networked Client/server Configuration Options
! Configuration
! Advantages
! Disadvantages
|-
| <b>StandaloneStand-alone</b>
|
* Simple to set up and maintain
* Limited IT knowledge required
* Can be upgraded to a networked client/server configuration later
|
* One-at-a-time data access
|-
| <b>NetworkedClient/server</b>
|
* Multiple concurrent data access
|
* Complicated to set up and maintain
* Networked Local Area Network infrastructure required
* Multiple computers required
|-
|}
In a networked client-/server configuration, one computer acts as a server and many other computers can connect to it simultaneously over a network, enabling multiple people to access the same data at the same time. A networked client/server installation requires at least two computers and a network infrastructure connecting the computers together. Using a networked client/server installation, a mine action programme can have multiple data entry clerks entering data at the same time.
[[Image:Understanding Configuration Options - Networked Config.png|center|300px|''Networked Client/server Config'']]
<div align="center">
''Networked ConfigurationClient/server configuration''
</div>
==Decentralized Information Exchange=={{Note| Be aware of the following when running IMSMA<sup>NG</sup> is designed to support information management in a decentralized context involving many users client/server installation:* The server and groups at various sitesclient(s) must be running the exact same version of IMSMA.* The gisServer. These users can include implementing partners, mine action operators and regional or decentralized mine action authoritiesproperties file on the server must be configured. Decentralizing information management within IMSMA<sup>NG</sup> is easy and allows information managers * The client(s) must be configured to connect to expand the scope and impact of information server. * Maps only need to be installed on mine action activitiesthe server. * Data entered into the server or clients will be automatically rendered to all clients (as well as the server). While IMSMA<sup>NG</sup> supports nearly any conceivable patterns for decentralized However, geospatial information exchange including multilateral exchange(points, peer-polygons) will NOT be immediately rendered to all clients. To either post your geospatial updates to-peer exchange and one- and two-direction exchange, the most prevalent pattern is that of a central mine action authority server (CMAthus making them available to other clients) and subordinate regional mine action authorities (RMAs). Much of or to receive updates from the discussion server, you must log out of maintaining a decentralized IMSMA<sup>NG</sup> system refers and then log back in.* Fonts will need to this typical example; however, many points apply to other information exchange patterns as well.be installed on both the server and client(s)}}
The centralized pattern is characterized by one or more non-overlapping regional sites or authorities that conduct data entry and data quality control for their region. Regional sites also typically perform some regional data analysis designed to support regional operations management and planning. By contrast, the central authority manages the overall data set for the entire country, collecting all regional information in order to perform national planning and produce national statistics.==Client/server Architecture==__NOEDITSECTION__
Whether a programme uses a stand-alone installation or a client/server installation, the IMSMA<sup>NG</sup> software has two main components:
[[Image:Understanding Configuration Options - Decentralized Info Exchange.png|center|''Decentralized Info Exchange'']]* the IMSMA<sup>NG</sup> server* the IMSMA<div align="center"sup>''Decentralized Info Exchange''NG</divsup>client
The figure below shows the parts of the software; the following sections then explain the functions that each part performs.
Establishing IMSMA<sup>NG</sup> with the correct configuration in this complicated context of multiple users and asynchronous data exchange is important to trouble{| border="1" cellpadding="5"|-free operations and highvalign="top"|[[Image:stand_alone Architecture.png|center|300px|''Stand-quality information management. The first step in ensuring the correct configuration is to document the information management flows.alone architecture'']]
In the following example, mine action field reports are entered at each regional site for the ongoing operations in that region. Field reports are reconciled, linked and approved according to the regional operations needs. Using the export functionality, the regional sites export data on a regular basis (for example, monthly) and send it to the central authority. (Regional information managers can use the search functionality to export the field reports entered since the last data exchange.) The central authority then imports the maXML files from each site and resolves any issues with the imports as well as performs quality control. When the import is complete, the central authority compiles a set of national statistics and then distributes a complete dataset (in the form of a database backup) to each of the regional sites. The regional sites restore the dataset and then import any data entered since the last export was sent to the central authority. When the backup is restored, regular data entry and exchange can continue, based on a common dataset|[[Image:Understanding Configuration Options- Client Server Architecture.png|center|600px|''Client/server architecture'']]
|}
[[Image:Understanding Configuration Options - Decentralized Info Management Flow.png|center|''Decentralized Info Management Flow'']]<div align="center">''Decentralized Info Management Flow</div>==Server===__NOEDITSECTION__
The IMSMA<sup>NG</sup> server stores data and manages much of the data processing. The server has two main parts, the datastore and the business layer. The datastore is where data is stored for retrieval by the IMSMA<sup>NG</sup> client. IMSMA<sup>NG</sup> uses a PostgreSQL relational database to store data on the server. Additionally, IMSMA<sup>NG</sup> stores other data including attachments and some configuration files on the server in file format. The PostgreSQL database is accessible via a variety of database access tools designed for browsing relational databases.
This straightforward approach {{warning|While the database contains many relational database constraints designed to decentralized preserve data exchange ensures that integrity, all sites regularly receive a complete and authoritative dataset. Other variations on this pattern are possible with varying degrees updates of increased complexity to meet specific data exchange needs. Regardless of should be handled through the information exchange pattern selected, there are several key aspects of maintaining decentralized data exchange within IMSMA<sup>NG</sup> that must be considered. These aspects are discussed business layer rather than with direct SQL updates in the following sectionsorder to maintain integrity.Failure to do so will likely cause data corruption or loss}}
===Ensuring Correct Roles The business layer is where rules are implemented to ensure data quality and Permissions are Assigned===Establishing correct roles consistency. The business layer takes data from the datastore and permissions is a key factor transforms it for display in managing and maintaining data exchange within the IMSMA<sup>NG</sup>client. Using All data interaction between the permissions structureclient and server database is handled through the business layer, which allows for multiple clients to be connected to the information manager can carefully control access to key functions that affect database while preserving data exchange including field report template creation, CDF creation, field report approvals and auxiliary data creationintegrity in cases of multiple requests. When permissions are correctly established and roles and user accounts created, information managers can freely distribute This includes access from the IMSMA<sup>NG</sup> dataset to regional partners knowing that key data controls are in placeclient and from the reporting tool.
Using the example of the central authority and regional sites, the following principles for user account creation and permissions should be considered:===Client===__NOEDITSECTION__
* The IMSMA<bsup>Central Authority:NG</bsup> Ensure central authority has exclusive control over user accounts client is the interface through which users can connect to the server and rolesbrowse the system, field report templatesenter data and generate outputs. The client includes an integrated GIS component and reporting tools. Based on ESRI’s ArcGIS Engine, the Data Inventory Manager GIS component performs all geospatial calculations including distance/bearing calculation, coordinate conversion and reprojection. The GIS component also allows each client to load and auxiliary manage its own maps and geographic data.* which the client receives from the IMSMA<bsup>Regional Sites:NG</bsup> Ensure that regional sites have data entryserver. As a result, approval each client receives and importlocally stores a complete copy of geographic data from the IMSMA<sup>NG</export permissionssup> server when it is connected to the server. Remove permissions for user accounts This synchronized data is stored in a client ―sandbox‖ separate from the server and roles and auxiliary datacan always be updated by connecting to the server.
By establishing a set of limited permissions for JasperSoft’s iReport tool is built into each IMSMA<sup>NG</sup> client and allows users to access data from the database via the regional sitesbusiness layer. With iReport, information managers users can prevent the accidental or intentional creation generate reports containing tabular data, subreports and cross tabs as well as various types of new data elements not available at the central authority charts and graphs. These reports can easily be localized into any language that could affect IMSMA<sup>NG</sup> supports. Additional reporting options include direct connections to the ability of the central authority to import field reports IMSMA<sup>NG</sup> database via ODBC. This functionality supports tools such as Crystal Reports, Microsoft® Access®, Microsoft Excel® and cause the dataset to become fracturedvarious open-source reporting tools.
===Creating New Auxiliary Data at the Central Authority LevelMemory settings===By limiting auxiliary data permissions to the central authority, information managers can prevent complications when synchronising field reports. Because field reports often refer to auxiliary data (places, ordnance, organisations, etc.), it is important that each site have a common set of auxiliary data to facilitate exchange. If the auxiliary data is not properly synchronised, the exchange of field reports can result in import issues which must be manually resolved. While IMSMA<sup>NG</sup> provides an interface for resolving these kinds of issues, it is recommended to reduce the occurrence of these issues by limiting any creation of auxiliary data to the central authority who can then distribute an updated dataset as necessary. Likewise, limiting the creation of field report templates, data elements and country structure levels to the central authority improves the ease of information exchange.__NOEDITSECTION__
===Sending Backups to Reset to a Common Dataset===The easiest way to ensure that each site is working from a common dataset is to distribute a full backup of the IMSMA<sup>NG</sup> dataset to each site on a regular basis. This can occur weeklyBy reserving memory for {{IMSMANG}}, monthly or quarterly, but the key is to distribute an official‖ dataset to each site regularly to ensure that auxiliary data is up to date and that any changes made to less memory may be used by other parts of the dataset are distributedapplications. In this way, organisations can maintain a common set of national statistics and It also depends on how much memory the dataset reflects the decisions made by the central authority computer has if is possible to resolve errors or issues in importing and exchanging field reportsreserve more memory for {{IMSMANG}}.
It is important to understand, however, that the restoration of a backup file overwrites the data at the regional site including any locally created searches and reports[[Image:memory_settings. So, the recipient sites should consider the following recommendations:png|500px]]
* Make a complete backup prior If you would like to restoring the central authority’s backup.* Export all field reports that have been entered since the last exchange with the central authority before restoring a backup.* Restore only reserve more memory for the IMSMA<sup>NG</sup> database and GIS database. This preserves local customisations of peripheral elements such as field report templates and iReport templatesserver '''process''', which can be reimported into IMSMA<sup>NG</sup>edit row 3 in ''C:\IMSMAng\trayLauncher\TrayLauncher.* Request that any searches or other non-exportable elements that are important for regional site use be created in the central authority’s dataset prior to distribution so they do not need to be recreated regionally each time a new backup is distributedproperties''.
===Collecting Regular Feedback===In any information exchange activity, it is important to have regular sessions or meetings to collect feedback and discuss issues or improvements If you would like to reserve more memory for the information exchange IMSMA client '''process''', edit row 12 in ''C:\IMSMAng\trayLauncher\TrayLauncher.properties''. One recommendation is Start with increasing it to establish a feedback forum where organisations can address data quality issues 1024 and make adjustments to the information exchange processthen evaluate. Topics to address in such a forum include:
* frequency of data exchange* standardization of reports and searches included in the central dataset* permissions and role changes* creation or modification of auxiliary data* form template changes By collecting feedback on these issues, information managers can help ensure that decentralized information exchange works as expected and set up a quality assurance mechanism to prevent data quality issues from affecting the programme’s information management.{||- valign==Managing IMSMA Roles and Permissions=="top"__FORCETOC__{{TOC right}}|
{{HowTo's|[[HowTo:Access and Use the Role List Window|Access and Use the Role List Window]]|[[HowTo:Use the Role Editor Window|Use the Role Editor Window]]}} {| class="wikitable" ! Value ! Role! DescriptionMeaning |-align="right"| Data Entry512 || Users whose primary function is to enter field reports and other data into the system. This role may or may not include the ability to approve field reports0.5 GB |-align="right"| Data Verification1024 || Users who typically perform quality checks on the data entered by Data Entry users. This role is often responsible for verifying the accuracy of the data entered and approving field reports.1 GB |-align="right"| Operations2048 || Users who typically browse for information within IMSMA<sup>NG</sup> to make operational decisions. Operations users may sometimes be grouped by function (for example, MRE, clearance or victim assistance). These users often perform searches for data, generate reports and analyze the data to support operational needs.2 GB |-align="right"| Systems Administrator3072 || 3 GB | Users who perform information management-specific functions such as creating field report templates, designing reports, backing up and restoring data and other technical functions.align="right"|-4096 | Guest| Users with essentially read-only access to browse data.4 GB |-align="right"
|}
The values should be increased step-by-step and evaluated after each change.
{{Note |
* Since IMSMA NG is a 32-bit application there is no effect by reserving more than total 4 GB.
* On the physical server in a client/server configuration there is need to start the client, take backup and restore so do not set the client process memory to less than 512. }}
 ==Client-Server Architecture== Whether a programme uses a stand-alone installation or a networked installation, the IMSMA<sup>NG</sup> software has two main components: * the IMSMA<sup>NG</sup> server* the IMSMA<sup>NG</sup> client The figure below shows the parts of the software; the following sections then explain the functions that each part performs. {{NavBox Information Management}}[[ImageCategory:Understanding Configuration Options- Client Server Architecture.png|center|500px|''Client Server Architecture''NAA]]<div align="center">''Client-Server Architecture''</div>  ===Server=== The IMSMA<sup>NG</sup> server stores data and manages much of the data processing. The server has two main parts, the datastore and the business layer. The datastore is where data is stored for retrieval by the IMSMA<sup>NG</sup> client. IMSMA<sup>NG</sup> uses a MySQL relational database to store data on the server. Additionally, IMSMA<sup>NG</sup> stores other data including attachments and some configuration files on the server in file format. The MySQL database is accessible via a variety of database access tools designed for browsing relational databases. The business layer is where rules are implemented to ensure data quality and consistency. The business layer takes data from the datastore and transforms it for display in the IMSMA<sup>NG</sup> client. All data interaction between the client and server database is handled through the business layer, which allows for multiple clients to be connected to the database while preserving data integrity in cases of multiple requests. This includes access from the IMSMA<sup>NG</sup> client and from the reporting tool. ===Client=== The IMSMA<sup>NG</sup> client is the interface through which users can connect to the server and browse the system, enter data and generate outputs. The client includes an integrated GIS and reporting tools. Based on ESRI’s ArcGIS Engine, the GIS performs all geospatial calculations including distance/bearing calculation, coordinate conversion and reprojection. The GIS also allows each client to load and manage its own maps and geographic data which the client receives from the IMSMA<sup>NG</sup> server. As a result, each client receives and locally stores a complete copy of geographic data from the IMSMA<sup>NG</sup> server when it is connected to the server. This synchronized data is stored in a client ―sandbox‖ separate from the server and can always be updated by connecting to the server. JasperSoft’s iReport tool is built into each IMSMA<sup>NG</sup> client and allows users to access data from the database via the business layer. With iReport, users can generate reports containing tabular data, subreports and cross tabs as well as various types of charts and graphs. These reports can easily be localized into any language that IMSMA<sup>NG</sup> supports. Additional reporting options include direct connections to the IMSMA<sup>NG</sup> database via ODBC. This functionality supports tools such as Crystal Reports, Microsoft® Access®, Microsoft Excel® and various open-source reporting tools.
6,632
edits

Navigation menu