This Starterkit showcases how to embed the front-end of Izenda into a MVC5 application that uses a stand-alone API back-end.
A. This is a simple example using a Visual Studio project template with Izenda Embedded into it. This repository is only an example of integrating Izenda into another application. The Visual Studio project template used in this scenario is used as a substitute for your application. This repository shows examples of how you might embed Izenda into your application.
-
Visit Izenda resource site and download / deploy the Izenda API to IIS. You need to create an API folder in your IIS and paste all Izenda API contents into that folder.
-
Run the mvc5_izenda.sql under the DBScript folder to create a database named 'MVC5_Izenda' (This is the database for the Izenda configuration. It contains report definitions, dashboards,etc.). You may use any name of your choosing, just be sure to modify the script to USE the new database name.
-
Create a izendadb.config with inserting following line : {"ServerTypeId":"572bd576-8c92-4901-ab2a-b16e38144813","ServerTypeName":"[MSSQL] SQLServer","ConnectionString":"[YOUR CONNECTION STRING]","ConnectionId":"00000000-0000-0000-0000-000000000000"} You need to update your ConnectionString. If the connection string contains a ‘/’, ensure that you escape it ‘//’ The ServerTypeId and ServerTypeName can be updated too based on your database type. For more information, please refer to this.
-
Insert izendadb.config file into the root of your API deployment.
-
Check mvc5_izenda database version and update it if migration required Izenda Migration Assistant
-
In the IzendaSystemSettings table, update AuthValidateAccessTokenUrl to be fully qualified with the Starterkit's base address. e.g. api/account/validateIzendaAuthToken --> http://localhost:14809/api/account/validateIzendaAuthToken
-
In the IzendaSystemSettings table, update AuthGetAccessTokenUrl to be fully qualified with the Starterkit's base address. e.g. api/account/getAccessToken --> http://localhost:14809/api/account/GetIzendaAccessToken
- Run the mvc5.sql under the DBScript folder to create a database named 'mvc5'. This is the database for the .NET application. It contains the users, roles, tenants used to login. You may use any name of your choosing, just be sure to modify the script to USE the new database name.
Create the Retail database with the retail.sql file under the DBScript folder.
izenda.integrate.js
- Modify the hostApi to point to the port of your Izenda API.
Web.Config
-
Update the connection string to point to your mvc5 database.
-
Update the IzendaApiUrl to point to the port of your Izenda API.
Create a izenda folder under the Scripts. Download the Izenda Embedded UI from Izenda resource site, and copy/store the files into the Scripts/izenda folder.
-
Use Izenda's RSA Key Generator Utility Located at http://downloads.izenda.com/Utilities/Izenda.Synergy.RSATool.zip
- AuthRSAPublicKey value in the IzendaSystemSettings table of the Izenda database (note: only use keysize < 1024 to generate because max-length for this field in database is 256) . This value is your public key and should be in XML format.
- And RSAPrivateKey value in Web.config file of the MVC Kit. This value is your private key and should be in PEM format.
e.g. value= 1 (BE Standlaone and FE integrated)
If you want to use Active Directory authentication, set useADlogin value in web.config to true.
- Log in as the System User First. Navigate to the Settings page to update your license key and add database connections. Log out of Izenda to allow these changes to take effect.
Initial User for logging in.
System User:
- Tenant:
- Username: IzendaAdmin@system.com
- Password: Izenda@123
DELDG:
Employee Role:
- Tenant: DELDG
- Username: employee@deldg.com
- Password: Izenda@123
Manager Role:
- Tenant: DELDG
- Username: manager@deldg.com
- Password: Izenda@123
VP Role:
- Tenant: DELDG
- Username: vp@deldg.com
- Password: Izenda@123
NATWR
Employee Role:
- Tenant: NATWR
- Username: employee@natwr.com
- Password: Izenda@123
Manager Role:
- Tenant: NATWR
- Username: manager@natwr.com
- Password: Izenda@123
VP Role:
- Tenant: NATWR
- Username: vp@natwr.com
- Password: Izenda@123
RETCL
Employee Role:
- Tenant: RETCL
- Username: employee@retcl.com
- Password: Izenda@123
Manager Role:
- Tenant: RETCL
- Username: manager@retcl.com
- Password: Izenda@123
VP Role:
- Tenant: RETCL
- Username: vp@retcl.com
- Password: Izenda@123
Update the WebUrl value in the IzendaSystemSetting table with the URL for your front-end. You can use the script below to accomplish this. As general best practice, we recommend backing up your database before making any manual updates.
UPDATE [IzendaSystemSetting]
SET [Value] = '<your url here including the trailing slash>'
WHERE [Name] = 'WebUrl'
If you do not update this setting, charts and other visualizations may not render correctly when emailed or exported. This will also be evident in the log files as shown below:
[ERROR][ExportingLogic ] Convert to image: System.Exception: HTML load error. The remote content was not found at the server - HTTP error 404
Ensure that the AuthValidateAccessTokenUrl and AuthGetAccessTokenUrl values in the IzendaSystemSetting table use the fully qualified path to those API endpoints.
Examples:
| Name | Value |
|---|---|
| AuthValidateAccessTokenUrl | http://localhost:14809/api/account/validateIzendaAuthToken |
| AuthGetAccessTokenUrl | http://localhost:14809/api/account/GetIzendaAccessToken |
You can use the script below to accomplish this. As general best practice, we recommend backing up your database before making any manual updates.
For Error- "You don't have permission to perform this action" , update "IzendaAdmin@system.com" value in UserName column of IzendaUser table.
UPDATE [IzendaSystemSetting]
SET [Value] = '<your url here>'
WHERE [Name] = 'AuthValidateAccessTokenUrl'
UPDATE [IzendaSystemSetting]
SET [Value] = '<your url here>'
WHERE [Name] = 'AuthGetAccessTokenUrl'
⛔ If these values are not set, the authentication will not work properly.