Web Application localisation

WA1. Procure Windows-based Server

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