Pre-installation Preparations

The setup of Izenda requires a download of the latest version of the stand-alone front-end and the back-end and a proper web server setup. Izenda can be installed on a local machine on a Windows machine for testing purposes and is a best practice for ensuring permissions and performance can be validated locally prior to moving toward more embedded and integrated examples, but it is not recommended for live deployments.

• Izenda installation packages, download them from the Upgrade tab in the Customer Portal.

  • An Izenda Front-end Package (Default name “App”)

    

  • An Izenda Back-end Package (Default name “API”)

    

• Server

  • Windows Server with Internet Information Services (IIS) Web Server.

Runtime Installation

Izenda depends on ASP.NET Core Runtime 6.0.13 runtime environment to run applications. This step is only required if you are installing Izenda 5.0.0 and above.

Install ASP.Net Core 6.0 runtime.

1. Download and install Hosting Bundle from Microsoft’s download page.

2. Check the version after installation by running “dotnet –info”.

Web Server Setup

To ensure that Izenda works properly, your Web Server requires additional components that may not be present on your server by default. If you are installing Izenda 4.0.0 and above, this step is not required.

Izenda Installation As Two Separate Sites

The most common testing scenario places the front-end and the back-end on two separate sites. Virtual Directories and Virtual Applications deployments are possible with additional configuration and are outlined in another section below.

1. Extract the Izenda Front-end and Back-end packages to 2 separate folders, preferably at C:\inetpub\wwwroot\Izenda\App and C:\inetpub\wwwroot\Izenda\API.

2. Izenda can be installed in multiple configurations: new website, new application to an existing website, or new virtual application under an existing website:

   • New website

     1. Right-click the local connection and select Add Website…

     2. Name the website IzendaApp and accept the Application pool with the same name.

     3. Click the ellipsis (…) button to select the location of the extracted Izenda Front-end package (C:\inetpub\wwwroot\Izenda\App).

     4. Skip the Connect as… and Test Settings… buttons for now, since permissions have not been set for Izenda package folders.

     5. Keep the port as 80 by default or change to any available port.

     6. Optionally enter the website address into host name box, but you will have to bind that address with the correct ip in “C:\WINDOWS\System32\drivers\etc\hosts” file.

        e.g. with website address www.acme.com and the ip 127.0.0.1, the following line needs to be added in hosts file: 127.0.0.1    www.acme.com

     7. Click OK to create the website.

     
     

3. Add new website for Back-end package:

   • Follow above steps and add another site for Izenda back-end with different port.

4. Set folder permissions

   1. Right-click the newly-created website, application or virtual application and select Edit Permissions to open the folder properties.

   2. In Security tab, click Edit to open Permissions dialog box.

   3. Click Add then enter IUSR then click OK (for IIS 7 and above).

      For older IIS versions, use NTAUTHORITY\\NETWORKSERVICE.

   4. Back in Permissions dialog box, tick the Modify check-box for IUSR.

   5. Click OK to close all dialogs.

      

   6. Set similar permissions for the other package.

5. Update the Back-end API url in Front-end package:

   Edit the file App\izenda_config.js, replace the default value “WebApiUrl” with the correct ip and port: "WebApiUrl":"http://127.0.0.1:8888/api/",

This concludes the steps necessary to install Izenda using two separate websites. Please refer to the following guides below: - Troubleshooting & Verifying the Installation - Common Izenda Stand-alone Installation Issues - Editing the Configuration Files

Deploying Izenda as a Virtual Directory or Application

Installing Izenda as a virtual directorys will mirror the steps taken required to deploy Izenda using two separate websites but additional modifications are necessary for the front end and back end to interact correctly together.

Troubleshooting & Verifying the Installation

• To ensure that your API site is running correctly, navigate to http://YOUR_API_URL/api/404 (e.g. http://localhost:8080/api/404)

  If your API is installed correctly, you should see the graphic below:

  

• Navigate to the API folder, you should see a ‘logs’ folder with with at least one log file. If you do not see the folder and/or files, verify that the application pool and/or web site user have write permissions to the API folder.

Common Izenda Standalone Installation Issues

Pre-install preparations

Runtime Installation - Izenda 5.0.0 and above

Izenda depends on ASP.Net Core 3.1 runtime environment to run applications.

1. Create an instance of Ubuntu 18.04

2. Login using ssh as the default user

3. Download and install .NET core 6.0 SDK run time env. Download here.

   wget https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb

4. Use dotnet--info to check the installation of .NET Core. You will get a confirmation notice if you performed a successful installation.

Install Izenda as two separate sites

1. Create izenda-ui.conf under /etc/apache2/sites-available: sudovim/etc/apache2/sites-available/izenda-ui.conf

   Listen 8080
   									<VirtualHost *:8080>
   									ServerAdmin webmaster@localhost
   									DocumentRoot /var/www/izenda-ui/StandaloneUI
   									ErrorLog /var/log/apache2/izenda-ui-error.log
   									CustomLog /var/log/apache2/Izenda-ui-access.log common
   									<Directory "/var/www/izenda-ui/StandaloneUI">
   									RewriteEngine on
   									# Don't rewrite files or directories
   									RewriteCond %{REQUEST_FILENAME} -f [OR]
   									RewriteCond %{REQUEST_FILENAME} -d
   									RewriteRule ^ - [L]
   									# Rewrite everything else to index.html to allow html5 state links
   									RewriteRule ^ index.html [L]
   									</Directory>
   									</VirtualHost>
   								

2. Create izenda-api.conf under //etc/apache2//sites-available: sudovim/etc/apache2/sites-available/izenda-api.conf

   Listen 8081
   									<VirtualHost *:8081>
   									ProxyPreserveHost On
   									ProxyRequests Off
   									ProxyPass / http://127.0.0.1:5000/
   									ProxyPassReverse / http://127.0.0.1:5000/
   									ServerName localhost
   									ErrorLog /var/log/apache2/izenda-api-error.log
   									CustomLog /var/log/apache2/Izenda-api-access.log common
   									</VirtualHost>
   								

3. Active the Front-end and Back-end sites.

   sudo a2ensite izenda-api.confsudo a2ensite izenda-ui.conf

4. Verify the configuration: sudoapachectlconfigtest. If the configuration is correct, the result will be SyntaxOk. If not, there is an issue in the configuration.

5. Update WebURL in Izenda_Config.js file with the proper prt (8081). WebApiUrl:"http://localhost:8087/api/

6. Provide write permission to current user

   sudo gpasswd -a "$USER" www-datasudo chown -R "$USER":www-data /var/wwwfind /var/www -type f -exec chmod 0660 {} \;sudo find /var/www -type d -exec chmod 2770 {} \;

7. Restart the website: sudoserviceapache2restart

8. Start your dotnet application: sudodotnetIzenda.BI.API.AspNetCore.dll. If the installation is success, you can browse you website via localhost with the 8080 port

Create monitor service

1. Install Supervisor, a monitor service app: sudoapt-getinstallsupervisor

2. Create supervisor config file: sudovim/etc/supervisor/conf.d/izenda-api.conf

3. Add the following content to the above file

   [program:dotnettest]command=/usr/bin/dotnet /var/www/izenda-api/API_AspNetCore/Izenda.BI.API.AspNetCore.dll  --urls "http://*:5000"directory=/var/www/izenda-api/API_AspNetCoreautostart=trueautorestart=truestderr_logfile=/var/log/izenda-api.err.logstdout_logfile=/var/log/izenda-api.out.logenvironment=ASPNETCORE_ENVIRONMENT=Productionuser=www-datastopsignal=INT

4. Command to start/stop the service

   • Start Supervisor: sudoservicesupervisorstart
   • Stop Supervisor: sudoservicesupervisorstop

5. Verifying the service running progress sudotail-f/var/log/izenda-api.out.log

Configuring Exporting

1. Configuring Exporting - Izenda v5.0.0 and above

• Apply file permission to the Export Engine’s executable in the Export folder of Izenda API - Linux example:

  1 sudo chmod 777 /API_AspNetCore/Export/CEFExporterLinux/Dundas.BI.Export.CEFExporter.exe

• For a Linux server:

• Install the X Virtual Frame Buffer (XVFB) service and support packages.

  1 sudo apt-get update && \

  2 apt-get install libasound2 libatspi2.0-0 libexpat1 libfontconfig1 libnspr4 libpangocairo-1.0-0 libxkbcommon-x11-0 \

  3 libnss3 libcairo2 libpango-1.0-0 libcups2 libxkbcommon0 libxshmfence1 libxcomposite1 libxdamage1 libxrandr2 libgbm1 libatk1.0-0 libatk-bridge2.0-0 xvfb --no-install-recommends -y

• Manually start XVFB service - Optional (Izenda API will start the service if it detects it is not already running)

  1 Xvfb :99 -screen 0 1024x768x24 -nolisten tcp >/dev/null 2>&1 &

• For a Windows server, install the required Visual C++ Redistributable Packages → https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170

Apply file permission to the Exporter Engine’s executable in the Export folder of Izenda API - Linux command example:

1 sudo chmod 777 /API_AspNetCore/Export/CEFExporterLinux/Dundas.BI.Export.CEFExporter.exe

Next: Install Izenda System Database and Apply License