Web Application localisation

WA1. Procure Windows-based Server

Minimum requirements

The minimum requirement to install and use openIMIS in a production environment are: 

• Windows Server 2016

• 2 core CPU

• 8 GB RAM

• 100 GB Hard drive

• Administrator privileges

You can acquire a VPS from any hosting provider (e.g. Azure, AWS) or create your own server backbone.

For development and testing purposes, please follow the minimum requirements on the following tools: 

• SQL Server minimal requirements

• Visual Studio 2017 minimal requirements (for other versions please check on Microsoft website)

WA2. Set up the default openIMIS instance

To set up the default openIMIS instance, please follow the steps: 

• WA2.1 Database installation
• WA2.2 Web Application installation
• WA2.3 Windows Services installation

If you want to start to localise openIMIS Web Application first and install the localised version afterwards, you can directly start from the localisation of the Web Application at the source code level.

WA2.1 Database installation

Install SQL Server

1. Download the desired version of SQL Server (for example, if you want to test openIMIS, you can download and install SQL Server 2017 Developer version - not for production ).

2. When the installation wizard opens, select the manual configuration option in order to fine-tune the installation process.

3. On the Features selection:

   1. In Shared Feature section, select SQL Client Connectivity SDK

   2. For installations with Data Warehouse, select Analysis Services, Reporting Services and Integration Services (not available for the Express edition)

4. On the Instance configuration, the default name SQLEXPRESS can be used, unless it is already used by another instance.

5. On Database engine configuration, select Mixed Mode (SQL Server authentication and Windows authentication) in Authentication Mode.

6. Continue the setup process until the installation is complete.

Configure SQL Server

1. Open the SQL Server Configuration Manager

   1. On the left panel, select SQL Server Network Configuration → Protocols for SQLEXPRESS (or the name of your SQL Server instance) → Enable Named Pipes and TCP/IP

   2. Select SQL Server Services → right-click on SQL Server instance name and select Restart

Initialize openIMIS database

1. First, download the openIMIS database SQL files and migration scripts from Github repository (the source code ZIP file).

2. If you wish to initialize the database using SSMS, follow the steps: 

   1. Create a new database for the openIMIS instance (e.g. openIMIS.1.4.0, where 1.4.0 is the openIMIS database version).

   2. Open the openIMIS_ONLINE.sql file (from the Empty databases folder) and execute the script (make sure the selected database is the one created in step a.)

3. If you prefer to initialize the database using the shell:

   1. Be careful to adapt the queries to your setup, in the command lines example those assumptions were made:

      1. The database is called IMIS_DATABASENAME

      2. The SQL server is called SQL_Server_Name

   2. Run the following commands:

      SqlCmd -E –Q "CREATE DATABASE IMIS_DATABASENAME" 
      SqlCmd -E -S SQL_Server_Name -d IMIS_DATABASENAME –i X:\PathToSQLFile\openIMIS_ONLINE.sql

4. Create a dedicated user with full privilege on the openIMIS database only:

   1. In the Security → Logins → right-click and select “New Login…”

   2. In General page:

      1. Give a login name (e.g. ImisUser)

      2. Select SQL Server authentication and provide a password

      3. Unselect Enforce password expiration

      4. Change the default database to openIMIS

   3. In User Mapping page:

      1. Map openIMIS database to ImisUser user

      2. Give the role of db_owner

Initialize specific openIMIS database

There are three specific openIMIS databases to chose from:

• Offline (openIMIS_OFFLINE.sql): this mode is used for remote insurance offices without Internet connectivity. Note: the synchronization of data with the central server is manual.

• Offline HF (openIMIS_OFFLINE_HF.sql): this mode can be used in remote health facilities without Internet connectivity. Note: the synchronization of data with the central server is manual.

• Demo (openIMIS_demo_ONLINE.sql): this script initialize the empty database with the demo dataset.

To initialize one of the specific openIMIS databases, follow the steps:

1. Initialize the openIMIS database by following the previous section steps

2. Run the specific database script on the already initialized openIMIS database

Upgrade the openIMIS database

To update a production instance and to prevent impacting the production if the migration script failed because of customizations in your openIMIS instance:

1. During the upgrade make sure the is not reachable from the applications (you should stop the openIMIS website in Web Application IIS).

2. Duplicate the database using SSMS or shell (create a full backup of the database and restore it with another database name, e.g. openIMIS.1.4.0)

   1. Shell commands (e.g. duplicate 'openIMIS.1.3.0' database to 'openIMIS.1.4.0' database; please adapt to your situation):

      SqlCmd -E -S SQL_Server_Name –Q "BACKUP DATABASE [openIMIS.1.3.0] TO DISK='X:\PathToBackupLocation\openIMIS.1.3.0.bak'" 
      SqlCmd -E -S SQL_Server_Name –Q "RESTORE DATABASE [openIMIS.1.4.0] FROM DISK='X:\PathToBackupLocation\openIMIS.1.3.0.bak' WITH MOVE 'openIMIS.1.3.0' TO 'C:\Program Files\Microsoft SQL Server\MSSQL14.MSSQLSERVER\MSSQL\DATA\openIMIS.1.4.0.mdf', MOVE 'openIMIS.1.3.0_log' TO 'C:\Program Files\Microsoft SQL Server\MSSQL14.MSSQLSERVER\MSSQL\DATA\openIMIS.1.4.0_log.ldf'"

3. Download the openIMIS database SQL files and migration scripts from Github repository (the source code ZIP file).

4. Execute the migration script on the copy of the database in SSMS or shell

   1. Shell command (e.g. from the current version 1.3.0 to the new version 1.4.0)

      SqlCmd -E -S SQL_Server_Name -d openIMIS.1.4.0 –i "X:\PathToMigrationScript\openIMIS migration v1.3.0 - v1.4.0.sql" 

5. Configure the openIMIS Web Application to use the newly migrated database (e.g. openIMIS.1.4.0).

6. Configure the openIMIS Backup Windows Service or your own backup application/service to use the newly migrated database (e.g. openIMIS.1.4.0).

7. Start your openIMIS website.

WA2.2 Web Application installation

Install IIS

In Windows Server, follow these steps to install IIS:

1. In the Server Manager → Dashboard → Add Roles and Features

2. Select Role-based or feature-based installation

3. Select your server from the server pool, and select your server from the list

4. In Server Roles → select Web Server (IIS) → Add Features

5. In Features

   1. Select .NET Framework 3.5

   2. Select .NET Framework 4.6 and ASP.NET 4.6 (or later)

6. In Web Server Role (IIS) → Role Services

   1. In Web Server, ensure that Common HTTP Features → Static Content is ticked

   2. In Application Development, select .NET Extensibility, ASP, ASP.NET, ISAPI Extensions, ISAPI Filters and Websocket Protocol

   3. In Management tools, tick all boxes

7. Click on Install and wait for the features to be installed

8. Restart the server if required

Download openIMIS Web Application

Download and unzip the release from Github web_app_vb repository into a new folder under the IIS wwwroot (e.g. C:\inetpub\wwwroot\openIMIS.1.4.0).

Configure IIS 

The configuration of IIS done through Internet Information Service (IIS) Manager.

Add a site

In Internet Information Service (IIS) Manager:

1. Select your server name → Sites

2. Remove the Default Web Site (if new installation)

3. Right-click on Sites → Add Website

4. Enter a site name for your openIMIS instance (e.g. openIMIS.1.4.0)

5. Enter or select the physical pathname (e.g. C:\inetpub\wwwroot\openIMIS.1.4.0)

6. If you have an SSL certificate, select binding type to HTTPS (port 443) and select your certificate

7. If you don't have an SSL certificate, select binding type to HTTP (port 80)

If you have selected the binding type to HTTPS (port 443), then you will have to add also the binding type for HTTP

1. Right-click on the new added website

2. Select Edit Bindings

3. Select binding type HTTP (port 80) and click ok

If you have a DNS address (e.g. demo.openimis.org) that is mapped to your server IP address, you can add it in the site binding configuration as the hostname. This will allow having multiple Sites deserving same ports (80 and 443) and can be used to have, for example, openIMIS development (e.g. dev.openimis.org) and production (e.g. demo.openimis.org) sites on the same server. 

Globalisation

Depending on the server’s initial configuration, the date format may differ from the expected DD/mm/YYYY format. To force the date format, go to the openIMIS site, then select Culture → .NET Globalisation, and select English (United Kingdom) (en-GB) as a culture.

Configure openIMIS Web Application

Edit the web.config 

The web.config provides the configuration for openIMIS Web Application, including database connection string and necessary folders.

To configure the database connection string, go in openIMIS root folder (e.g. C:\inetpub\wwwroot\openIMIS.1.4.0), locate the web.config file and edit IMISConnectionString entry so that the connection string points to the database created in openIMIS database section with the right credentials. For example:

<connectionStrings>
    <add name="IMISConnectionString" connectionString="Data Source=WIN-H4E4ARREBFH\SQLEXPRESS;Initial Catalog=openIMIS.1.4.0;User ID=ImisUser;Password=password1234" providerName="System.Data.SqlClient" />
</connectionStrings>

Other configuration settings can be found within the <appSettings> tag and should be modified with caution.

Assign permission to source folders

In openIMIS root folder (e.g. C:\inetpub\wwwroot\openIMIS.1.6.0), IIS_IUSRS need to be given full control of the following folders: Archive, Extracts, FromPhone, Images, Workspace.

Repeat the following steps for each folder listed above:

1. Right-click on the folder and select properties

2. Ensure that the folder is not read-only

3. Select the Security tab

4. Click on Edit

5. Select IIS_IUSRS and allow full control (in the below section).

6. Then apply and click OK.

This can also be done automatically for all the above mentioned folders by running the provided set_folders_rights.ps1 script from a PowerShell console with Administrator rights (right click on PowerShell shortcut and select Run as administrator.

Edit permissions to Windows event logs

Click on the Windows Start menu of run Regedit via the search box:

1. In the Registry Editor, select HKEY_LOCAL_MACHINE → System → CurrentControlSet → Services → Eventlog.

2. Right-click on the EventLog node, select Permission. Give full permissions to IIS_IUSRS, as described in the above paragraph (Assign permission to source folders). If the IIS_IUSRS user is not present in the list, then click Add button to add it manually. 

3. Now repeat the same steps for Eventlog → Security and Eventlog → State node, as it can be required depending on the server’s environment.

Additional resources:

• How to fix permissions error on Windows event logs?

Open the application

Open your Internet browser and type the following URL in the browser address bar: http://localhost/

You can connect with the following credentials:

If you have initiated the openIMIS Blank Database:

• Login name: Admin

• Password: Admin

If you have initiated the openIMIS Demo Database:

• Login name: Admin

• Password: admin123

WA2.3 Windows Services installation

The following Windows Services are available: 

• Policy Renewal service: periodically marks the policies that will expire in the near future to be renewed and updates the status of the already expired policies The openIMIS Windows Services are helping with the periodic activities which are required by the implementations. 

• Backup service: periodically creates a backup of the database 

Install Windows Services

To install the Windows Service, proceed as follows for each Service:

1. Download and unzip the installation setup from the links mentioned in the available Services

2. Double click on the setup file

3. Select the installation path (for example C:\Program Files\openIMIS\Windows Services), and click Next

4. Close after the installation completes

The installed Service should start automatically as indicated in the system tray. If not, browse to Programs menu and search for the Service name (the controller of the service) and execute it.

Fix broken services 

To fix initial configuration files:

1. Run IMIS Policy Renewal (if an error window appears, click Continue)

2. Right-click the Policy Renewal icon in the system tray (lower-right corner of Windows) and click Settings

3. Fill the newly-created window Imis Renewal Policy as follows (please adapt to your situation):

   1. Server: .\SERVERNAME

   2. Database: openIMIS.1.3.0 

   3. User Name: ImisUser

   4. Password: Pa$$w0rd

   5. Time: 00:00

   6. Interval: 24

   7. Untick all Send SMS to... options

   8. Click Apply

4. Make a copy of the file ImisPolicyRenewal.exe.config inside C:\Program Files\openIMIS\Windows Services within the same folder

5. Rename the copy into ImisBackup.exe.config

To fix service startup:

1. Run Services

2. Locate ImisBackup and ImisPolicyRenewal, and do the following for each:

   1. Double-click the said entry

   2. Click the Log On tab

   3. Select the Local System account option

   4. Tick the Allow service to interact with desktop checkbox

   5. Click OK

   6. Right-click the said entry

   7. Click either Restart or Start (whichever is possible)

   8. Locate its icon in the system tray (lower-right corner of Windows)

   9. Right-click the said icon and click Settings

   10. Fix field values, if needed

Configure the ImisPolicyRenewal Windows Service

This service is used to update insurance policies and runs every day at the specified time. It will do the following actions:

1. If it finds a policy which is about to expire within a specified period of time, it flags it as to be renewed. The list of policies to be renewed can be used by the Enrolment Officers to contact the concerned families. The default policy expiring period of time is 14 days.

2. Sets the policy status to expired to all policies that have expired in between this Service runs.

3. Sends SMS to insuree if their policy is about to expire so that they can renew the policy (optional).

After the service installation, the user has to set the name of the server, the database name, the SQL-server instance credentials, and the service schedule for checking which policy is to be flagged as expired policy.

The days specified before the exact policy expiry date is provided in the table tblIMISDefaults under openIMIS Live database. The figure below shows the interface for policy renewal service.

Under the SMS gateway setting, you need to specify the URL given by SMS Gateway provider. You also need to provide the username and password to allow the service to send SMS to the insuree. 

Configure the ImisBackup Windows Service

This service is used for database backup, after the service installation, the user has to set the name of the server, the database name, the SQL-server instance credentials, and the service schedule for the backups.

The backup location is specified in the table tblIMISDefaults under openIMIS Live database. The figure below shows the interface for the database backup service.

WA3. Localise openIMIS at Web Application's source code level

If you want to localise openIMIS Web Application component, you will need first to download the source code for the Web Application from Github. 

The .NET Web Application has been developed to be used in different insurance contexts and with the idea of minimal adaptations. Most of the configuration is saved in the database. However, there are some specific requirements that will have to change the Web Application's source code. 

The .NET Web Application can be customised as follows:

• WA3.1 Escape procedures
• WA3.2 Language translation
• WA3.3 Deploy the localized Web Application
• WA3.4 Web configuration file

WA3.1 Escape procedures

The role of the Escape procedures is to allow adaptation of the Web Application to different insurance contexts. There are situated in a single class, EscapeBL, which makes it easier to access and modify without having to worry about messing with the whole Web Application source code. To modify the escape procedure, first download the source code from Github Web Application repository. Within the solution, go to IMIS_BL folder and open the EscapeBL.vb file. 

There are 2 escape procedures that can be modified: 

1. isValidInsuranceNumber allows validating the insuree number based on predefined rules. It is used, for example, when a new family or insuree are enrolled in openIMIS to ensure insuree number validity and to prevent typing errors.

2. SendSMS allows sending SMS messages through a specific SMS Gateway. It is used, for example, in Web Application Policy Renewal form to send the renewal SMS message to the family.

Localise the insuree number validation escape procedure

In this guide, we will localise the isValidInsuranceNumber method. 

This is the generic implementation of the method:

Public Function isValidInsuranceNumber(ByVal InsuranceNumber As String) As Boolean
   Return True
End Function

The generic method is returning always true, meaning any insuree number will be a valid one. 

Let's take for example the following insuree number requirements:

1. The insuree number must follow the modulo 9 rule: the last digit is the modulo 9 of the number without the last digit

2. The insuree number must have 10 digits ('0' at the beginning must be saved)

These requirements are satisfied by the following escape procedure: 

Public Function isValidInsuranceNumber(ByVal InsuranceNumber As String) As Boolean
    If Not InsuranceNumber.ToString.Length = 10 Then Return False
    Dim N As String = Left(InsuranceNumber.ToString, 9)
    Dim Modulo As String = Right(InsuranceNumber.ToString, 1)
    If Modulo = N - (Int(N / 9) * 9) Then Return True
    Return False
End Function

The isValidInsuranceNumber is executing the following steps: 

1. validates the length of the insuree number (line 2)

2. splits the insuree number into number and modulo parts (lines 3 and 4)

3. validates the insuree number if the modulo part is equal to the modulo result (line 5)

4. all other cases are invalidated (line 6)

Other validations rules can be applied.

To apply the new modification to the escape procedures, the Web Application .Net solution needs to be published and deployed. 

WA3.2 Language translation

Web Application .Net is supporting up to two languages. The language translation is done on the Web Application source code level (this page) and on the database level (see WA4.1 Language selection and translation tables). 

The Web Application language localisation is using the default ASP.Net Globalization and Culture configuration. The translation is based on resource files. The generic application is translated into English-language and French-language.

In order to facilitate the translation of the Web Application and to have a common repository for language packs for openIMIS, we have subscribed to lokalise.com. If you wish to add new languages to openIMIS Web Application, you can request the access by visiting the Web Application project on lokalise. For more information on the translation platform please check Translation Management platform page.

Add a new language for Web Application in lokalise

1. Add new language to the project

   1. From the Web Application project press the + button to add a new language

      

   2. From the Add languages modal select the language to add. You can filter the languages by writing in the input field. In this example, we will choose French (Cameroon). Multiple languages can be added at once.

      

   3. Click the Add button. 

2. Translate the glossary to the new language 

   1. From the Web Application project press the Glossary button to add a new language

      

   2. For each glossary term, translate in the new added language

      

3. Translate the Web Application into the new language

   1. For each term in the Web Application project, translate it in the new language

      

4. Export the language as .Net resource file

   1. From the Web Application project press the Download button

      

   2. Select the language you want to download and the different download settings

      

   3. Press Build and download button. This will download a ZIP file with resource files for all selected languages. Unzip 

Add the new language in the Web Application project 

1. Open in Visual Studio the Web Application .Net solution downloaded from Github

2. In the Solution Explorer window, navigate to IMIS project → App_GlobalResources folder and open the contextual menu with right-click 

3. Select Add → Existing Item...

4. Select the resource file for the new language and press Add. This will copy the file to the App_GlobalResources folder and add it to the project. 

5. (Optional) you can check the new language by opening the resource file. 

To use the new language, the Web Application .Net solution needs to be published and deployed. Nevertheless, you cannot use the new language unless you update the language selection and translation tables in the database. 

Why Glossary is important

Because there is multiple truth and it is often complex and can change over time, the terminology must have the same meaning and same wording in the whole Web Application. It is also important that the country-specific names are validated by the country implementing openIMIS. 

When using a glossary you ensure that you will use the same 'truth' across your application. In the case of lokalise, every time it will detect the glossary term, it will show the definition and the translation, allowing to be consistent in the translation package.

For example, in Tchad there are the different organisation names which must be adapted in openIMIS:

WA3.3 Deploy the customised Web Application

WA4. Localise openIMIS at the database level

Some of the configuration/localisations of the Web Application can be done in the openIMIS database: mandatory if you change the default translation languages or optional for user interface configuration and default configuration. 

In this section, we will localise openIMIS on database level: 

• WA4.1 Language selection and translation tables
• WA4.2 Control table
• WA4.3 IMIS default configuration

WA4.1 Language selection and translation tables

In language translation section, we have added another language to the Web Application as a resource file. However, you cannot use the new language unless you add this language as an option in the database. In addition to this, you will need to customise and translate the dropdown lists to have a completely translated version of openIMIS.

Customisation and translation of the dropdown list

Before configuring the available languages in openIMIS, lets first add the translation for the different dropdown list. openIMIS is using dropdown lists in both Web Application and mobile applications to allow users to modify entities attributes.

The following tables contain dropdown translations: 

For example, the Education dropdown list from the Web Application's Add Family form allows to chose the family head's level of education. 

There are two advantages of having the dropdown list options in the database:

it is easier to translate without publishing again the applications 

it is easier to add or remove options based on the scheme/implementation/country requirements

The downside of this is the limit to the number of languages that can be supported. All dropdown translation tables have the following structure: 

This structure allows only two languages to be used in openIMIS. For example, in Tanzania, the two languages are English and Swahili. 

Because the available dropdown options depend on the scheme/implementation/country requirements, the customisation of the dropdown lists is part of the scheme configuration. 

Language selection configuration 

The available languages that can be selected in the Web Application and mobile applications are configured in the tblLanguages table in the openIMIS database. As we have seen in the previous section, the dropdown translation tables are limiting the number of available languages to two. 

In case you added another language in the Web Application source code, you will need to replace here one language with the new one (usually second language).

The following structure is presented in the languages table:

Please pay attention to the LanguageCode. It represents language code used for the Web Application resource files (e.g. Resource.fr.resx). If you use Lokalise, the code is represented by the %LANG_ISO% code of the translation language (fr_CM for the Cameroon example). The length of the LanguageCode has been updated in October 2019 release to allow ISO 639 and ISO 3166 coding (e.g. fr_FR).

WA4.2 Control table

The openIMIS database's tblControls table allows configuring specific forms in both Web Application and Mobile Applications. This configuration will be based on the requirements of the implementation site. 

For selected forms, some fields can have the following attributes:

The following fields can be localised. Note: the field names are the same as named in the tblControls table.

WA4.3 IMIS default configuration

The openIMIS database's tblIMISDefaults table allows configuring specific forms in both Web Application and Mobile Applications. This configuration will be based on the requirements of the implementation site. 

The following attributes can be configured:

WA5. Web Application configuration

The following sections present the configuration that can be done within openIMIS Web Application that is not insurance related configuration. 

Configure the Email settings 

When users forget their password and request a new password, an email is sent to validate the new credentials. 

In openIMIS, the following roles can change the email settings: IMIS Administrator, HF Administrator and Offline Administrator. 

To change the email settings, go to the menu Tools → Email Settings. 

In the form (see image), enter the following information : 

Please request to your email provider the SMTP server configuration for your email address used to send emails from openIMIS. 

WA6. Building of registers

In order to use openIMIS, you need to configure the Insurance related registers based on the implementation context. This configuration of the registers (also called the Master Data) can be done in different ways. 

• WA6.1 Bulk uploads from Web Application user interface
• WA6.2 Use the Database Import Tool
• WA6.3 Manual configuration

WA6.1 Bulk uploads from Web Application user interface

Implementation-related information can be configured in different ways. The user documentation explains bulk upload/download functionality of in general. In this page, we give examples of register files that can use by the functionality. 

The bulk upload/download functionality can be accessed through the menu Tools → Registers.

Upload diagnoses 

Because the diagnoses list can be quite long, the configuration of the diagnoses in openIMIS Web Application can be done only by uploading the list encoded as an XML document. 

DTD definition of the XML file for uploading/downloading of diagnoses is:

<!DOCTYPE Diagnoses [
	<!ELEMENT Diagnoses (Diagnosis*)>
	<!ELEMENT Diagnosis (DiagnosisCode, DiagnosisName)>
	<!ELEMENT DiagnosisCode (#CDATA)>
	<!ELEMENT DiagnosisName (#CDATA)>
]>

An example of an XML file that uses and conforms to this DTD follows.

<?xml version="1.0" encoding="utf-8"?>
<Diagnoses>
	<Diagnosis>
		<DiagnosisCode>A00</DiagnosisCode>
		<DiagnosisName>Cholera</DiagnosisName>
	</Diagnosis>
	<Diagnosis>
		<DiagnosisCode>A01</DiagnosisCode>
		<DiagnosisName>Typhoid and paratyphoid fevers</DiagnosisName>
	</Diagnosis>
	<Diagnosis>
		<DiagnosisCode>A02</DiagnosisCode>
		<DiagnosisName>Other salmonella infections</DiagnosisName>
	</Diagnosis>
	<Diagnosis>
		<DiagnosisCode>A03</DiagnosisCode>
		<DiagnosisName>Shigellosis</DiagnosisName>
	</Diagnosis>
	<Diagnosis>
		<DiagnosisCode>A04</DiagnosisCode>
		<DiagnosisName>Other bacterial intestinal infections</DiagnosisName>
	</Diagnosis>
	<Diagnosis>
		<DiagnosisCode>A05</DiagnosisCode>
		<DiagnosisName>Other bacterial foodborne intoxications, not elsewhere classified</DiagnosisName>
	</Diagnosis>
	<Diagnosis>
		<DiagnosisCode>A06</DiagnosisCode>
		<DiagnosisName>Amebiasis</DiagnosisName>
	</Diagnosis>
</Diagnoses>

A ready to use ICD10 first-level diagnoses list can be downloaded here: ICD10.xml

To upload the diagnoses list please follow the instruction in the user manual. 

If there are errors in the diagnoses list or you want to add/remove diagnoses, the easier is to download the current list, do the modifications and upload the list again. 

Upload locations

The list of locations can be configured in different ways. The simplest and intuitive way is through the user interface. In this section, we explain how to configure the locations by uploading the list formatted as an XML document.

DTD definition of the XML file for uploading/downloading of locations is:

<!DOCTYPE Locations [
	<!ELEMENT Locations (Regions, Districts, Municipalities, Villages)>
	<!ELEMENT Regions (Region*)>
	<!ELEMENT Region (RegionCode, RegionName)>
	<!ELEMENT RegionCode (#CDATA)>
	<!ELEMENT RegionName (#CDATA)>
	<!ELEMENT Districts (District*)>
	<!ELEMENT District (RegionCode, DistrictCode, DistrictName)>
	<!ELEMENT RegionCode (#CDATA)>
	<!ELEMENT DistrictCode (#CDATA)>
	<!ELEMENT DistrictName (#CDATA)>
	<!ELEMENT Municipalities (Municipality*)>
	<!ELEMENT Municipality (DistrictCode, MunicipalityCode, MunicipalityName)>
	<!ELEMENT DistrictCode (#CDATA)>
	<!ELEMENT MunicipalityCode (#CDATA)>
	<!ELEMENT MunicipalityName (#CDATA)>
	<!ELEMENT Villages (Village*)>
	<!ELEMENT Village (MunicipalityCode, VillageCode, VillageName, MalePopulation?, FemalePopulation?, OtherPopulation, Families?)>
	<!ELEMENT MunicipalityCode (#CDATA)>
	<!ELEMENT VillageCode (#CDATA)>
	<!ELEMENT VillageName (#CDATA)>
	<!ELEMENT MalePopulation (#CDATA)>
	<!ELEMENT FemalePopulation (#CDATA)>
	<!ELEMENT OtherPopulation (#CDATA)>
	<!ELEMENT Families (#CDATA)>
]>

An example of an XML file that uses and conforms to this DTD follows.

<?xml version="1.0" encoding="utf-8"?>
<Locations>
  <Regions>
    <Region>
      <RegionCode>R1</RegionCode>
      <RegionName>Ultha</RegionName>
    </Region>
    <Region>
      <RegionCode>R2</RegionCode>
      <RegionName>Tahida</RegionName>
    </Region>
  </Regions>
  <Districts>
    <District>
      <RegionCode>R1</RegionCode>
      <DistrictCode>R1D1</DistrictCode>
      <DistrictName>Rapta</DistrictName>
    </District>
    <District>
      <RegionCode>R2</RegionCode>
      <DistrictCode>R2D1</DistrictCode>
      <DistrictName>Rajo</DistrictName>
    </District>
  </Districts>
  <Municipalities>
    <Municipality>
      <DistrictCode>R2D1</DistrictCode>
      <MunicipalityCode>R2D1M1</MunicipalityCode>
      <MunicipalityName>Jaber</MunicipalityName>
    </Municipality>
    <Municipality>
      <DistrictCode>R1D1</DistrictCode>
      <MunicipalityCode>R1D1M2</MunicipalityCode>
      <MunicipalityName>Jamu</MunicipalityName>
    </Municipality>
    <Municipality>
      <DistrictCode>R1D1</DistrictCode>
      <MunicipalityCode>R1D1M3</MunicipalityCode>
      <MunicipalityName>Adhi</MunicipalityName>
    </Municipality>
  </Municipalities>
  <Villages>
    <Village>
      <MunicipalityCode>R2D1M1</MunicipalityCode>
      <VillageCode>R2D1M1V1</VillageCode>
      <VillageName>Utha</VillageName>
      <MalePopulation>0</MalePopulation>
      <FemalePopulation>0</FemalePopulation>
      <OtherPopulation>0</OtherPopulation>
      <Families>0</Families>
    </Village>
	<Village>
      <MunicipalityCode>R1D1M2</MunicipalityCode>
      <VillageCode>R1D1M2V1</VillageCode>
      <VillageName>Jamula</VillageName>
      <MalePopulation>0</MalePopulation>
      <FemalePopulation>0</FemalePopulation>
      <OtherPopulation>0</OtherPopulation>
      <Families>0</Families>
    </Village>
	<Village>
      <MunicipalityCode>R1D1M3</MunicipalityCode>
      <VillageCode>R1D1M3V1</VillageCode>
      <VillageName>Rathula</VillageName>
      <MalePopulation>0</MalePopulation>
      <FemalePopulation>0</FemalePopulation>
      <OtherPopulation>0</OtherPopulation>
      <Families>0</Families>
    </Village>
  </Villages>
</Locations>

To upload the location list please follow the instruction in the user manual. 

If there are errors in the location list or you want to add/remove locations, the easier is to edit from the user interface by accessing Administration → Locations from the menu. 

Upload health facilities

As for the locations, the health facilities can be configured in different ways and the most intuitive and simple way is through the user interface. In this section, we explain how to configure the health facilities by uploading the list formatted as an XML document.

DTD definition of the XML file for uploading/downloading of health facilities is:

<!DOCTYPE HealthFacilities [
	<!ELEMENT HealthFacilities (HealthFacilityDetails, CatchmentsDetails)>
	<!ELEMENT HealthFacilityDetails (HealthFacility*)>
	<!ELEMENT HealthFacility (LegalForm, Level, Sublevel, Code, Name, Address, DistrictCode, DistrictName, Phone, Fax, Email, CareType, AccountCode, ItemPriceListName, ServicePricelistName)>
	<!ELEMENT LegalForm (D|C|G|P)> 	<!-- District organization | Charity | Government | Private organization -->
	<!ELEMENT Level (D|C|H)> 			<!-- Dispensary | Health Centre | Hospital -->
	<!ELEMENT SubLevel (I|N|R)>		<!-- Integrated | No Sublevel | Reference -->
	<!ELEMENT Code (#CDATA)>
	<!ELEMENT Name (#CDATA)>
	<!ELEMENT Address (#CDATA)>
	<!ELEMENT DistrictCode (#CDATA)>
	<!ELEMENT DistrictName (#CDATA)>
	<!ELEMENT Phone (#CDATA)>
	<!ELEMENT Fax (#CDATA)>
	<!ELEMENT Email (#CDATA)>
	<!ELEMENT CareType (I|O|B)>		<!-- In-Patient | Out-Patient | Both -->
	<!ELEMENT AccountCode (#CDATA)>
	<!ELEMENT ItemPriceListName (#CDATA)>
	<!ELEMENT ServicePriceListName (#CDATA)>
	<!ELEMENT CatchmentsDetails (Catchment*)>
	<!ELEMENT Catchment (HFCode, VillageCode, VillageName, Percentage)>
	<!ELEMENT HFCode (#CDATA)>
	<!ELEMENT VillageCode (#CDATA)>
	<!ELEMENT VillageName (#CDATA)>
	<!ELEMENT Percentage (#CDATA)>
]>

An example of an XML file that uses and conforms to this DTD follows.

<?xml version="1.0" encoding="utf-8"?>
<HealthFacilities>
  <HealthFacilityDetails>
    <HealthFacility>
      <LegalForm>G</LegalForm>
      <Level>H</Level>
      <SubLevel />
      <Code>JMHOS001</Code>
      <Name>Jambero District Hospital</Name>
      <Address>Lantern Road 21 P.O.Box 3425</Address>
      <DistrictCode>R1D2</DistrictCode>
      <DistrictName>Jambero</DistrictName>
      <Phone />
      <Fax />
      <Email />
      <CareType>B</CareType>
      <AccountCode>DL0002</AccountCode>
      <ItemPriceListName>Ultha Govt. Hospital List</ItemPriceListName>
      <ServicePriceListName>Ultha Govt. Hospital List</ServicePriceListName>
    </HealthFacility>
    <HealthFacility>
      <LegalForm>G</LegalForm>
      <Level>C</Level>
      <SubLevel />
      <Code>JMHC001</Code>
      <Name>Jamini Health Centre</Name>
      <Address>Reduci road 42</Address>
      <DistrictCode>R1D2</DistrictCode>
      <DistrictName>Jambero</DistrictName>
      <Phone />
      <Fax />
      <Email />
      <CareType>O</CareType>
      <AccountCode />
      <ItemPriceListName>Ultha Govt. Health Centre List</ItemPriceListName>
      <ServicePriceListName>Ultha Govt. Health Centre List</ServicePriceListName>
    </HealthFacility>
    <HealthFacility>
      <LegalForm>G</LegalForm>
      <Level>D</Level>
      <SubLevel />
      <Code>JMDP001</Code>
      <Name>Huda Dispensary</Name>
      <Address>Jolywel road 675</Address>
      <DistrictCode>R1D2</DistrictCode>
      <DistrictName>Jambero</DistrictName>
      <Phone />
      <Fax />
      <Email />
      <CareType>O</CareType>
      <AccountCode />
      <ItemPriceListName>Ultha Govt. Dispensary List</ItemPriceListName>
      <ServicePriceListName>Ultha Govt. Dispensary List</ServicePriceListName>
    </HealthFacility>
  </HealthFacilityDetails>
  <CatchmentDetails>
    <Catchment>
      <HFCode>JMDP001</HFCode>
      <VillageCode>R1D2M2V1</VillageCode>
      <VillageName>Agilo</VillageName>
      <Percentage>100</Percentage>
    </Catchment>
    <Catchment>
      <HFCode>JMDP001</HFCode>
      <VillageCode>R1D2M1V1</VillageCode>
      <VillageName>Holobo</VillageName>
      <Percentage>100</Percentage>
    </Catchment>
    <Catchment>
      <HFCode>JMDP001</HFCode>
      <VillageCode>R1D2M1V2</VillageCode>
      <VillageName>Octo</VillageName>
      <Percentage>100</Percentage>
    </Catchment>
    <Catchment>
      <HFCode>JMDP001</HFCode>
      <VillageCode>R1D2M1V3</VillageCode>
      <VillageName>Raberjab</VillageName>
      <Percentage>100</Percentage>
    </Catchment>
  </CatchmentDetails>
</HealthFacilities>

To upload the health facilities list please follow the instruction in the user manual. 

If there are errors in the location list or you want to add/remove locations, the easier is to edit from the user interface by accessing Administration → Health Facilities from the menu.

WA6.2 Use the Database Import Tool

Implementation-related information can be configured in different ways: through bulk upload/download, through the Web Application user interface. In this page, we explain how to use the openIMIS Database Import Tool to manually import the information directly into the database. 

openIMIS Database Import Tool

The openIMIS Database Import Tool is a spreadsheet that allows Implementers to define the list of medical items, medical services, diagnoses and health facilities. With the help of a Database Manager, the lists can be then imported directly into the database by executing the generated SQL scripts.

The openIMIS Database Import Tool can be downloaded from Github openIMIS Database repository.

How to use the Database Import Tool

• Open the Registers_init.ods

• Each tab corresponds to a register e.g. tblHF for Health Facilities

• Delete the sample data from the template

• Insert the data to be imported into openIMIS (the comments allows to understand how the data should be codded)

• SQL insert statements are generated in the same worksheet as data is typed in

• Copy those statement in the database manager (e.g. SQL Server management studio) and run them

WA6.3 Manual configuration

We have seen in the previous sections two ways of configuring openIMIS insurance-related information through bulk uploads and by inserting directly in the database. The most common way to do the configuration is through the Web Application user interface. 

This manual configuration is explained in the user manual. 

Based on the dependencies between openIMIS entities, we suggest that you follow this order in the manual configuration process:

1. User roles definition 

2. Location tree

3. User creation (dependent on User roles and Location)

4. Payers (if contributions are not paid by the insurees; dependent on Location)

5. Medical Services 

6. Medical Items

7. Medical Services Price Lists (dependent on Location and Medical Services)

8. Medical Items Price Lists (dependent on Location and Medical Items)

9. Health Facilities (dependent on Location, Medical Services Price List and Medical Items Price List)

10. Insurance Products (dependent on Location, Medical Services and Medical Items)

11. Enrolment Officers (dependent on Location)

12. Claim Administrators (dependent on Location)