Skip to content

Izenda7Series/Htmlcore_dm1_starterkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 

Repository files navigation

Izenda HTML Core Starterkit (Back-end Standalone)

Overview

This Starterkit showcases how to embed the front-end of Izenda into a HTML Core application that uses a stand-alone API back-end.

Q. What is in this repository?

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.

⚠️ The HTML Core Kit is designed for demonstration purposes and should not be used as an “as-is” fully-integrated solution. You can use the kit for reference or a baseline but ensure that security and customization meet the standards of your company.

⚠️ This deployment is currently using version 3.8.4. If you wish to update to a later version, ensure that you run the appropriate schema migration scripts.

Deploying the standalone API and Izenda Configuration Database

  • Download and Install the .Net core Windows hosting bundle.

  • Download and deploy the Izenda Asp.Net Core API to IIS.

  • Run the HTMLCore_Api.sql inside DBScripts folder to create a database named 'HTMLCore_Api' (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.

  • Check HTMLCore_Api database version and update it if migration required Izenda Migration Assistant

  • Download a copy of the izendadb.config file, and copy it to the root of your API deployment. Then modify the file with a valid connection string to this new database. If the connection string contains a ‘/’, ensure that you escape it ‘//’

  • In the IzendaSystemSettings table, update AuthValidateAccessTokenUrl to be fully qualified with the Starterkit's base address. e.g. api/account/validateIzendaAuthToken --> http://localhost:19657/api/user/validateIzendaAuthToken

  • In the IzendaSystemSettings table, update AuthGetAccessTokenUrl to be fully qualified with the Starterkit's base address. e.g. api/getAccessToken --> http://localhost:15657/api/user/GetIzendaAccessToken

Deploying the HTML Core Starter Kit Database

  • Run the HTMLCore.sql inside DBScripts folder to create a database named 'HTMLCore'. This is the database for the .NET application. It contains the users, 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.

Deploying the Retail Database (optional)

Create the Retail database with the retail.sql inside DBScripts folder.

Deploying the HTML Core Kit

izenda.integrate.js

  • If required, modify the hostApi to point to the port of your Izenda API. Default port number is 6360.

appsettings.json

  • Update the connection string to point to your HTMLCore database.

Download the Izenda Embedded UI, and copy/paste the files into the Website/izenda folder.

Publish Website from Visual Studio to create HtmlCoreApp site in IIS set your port number (e.g., 8000) and permission level correctly.

Run HTML Core project from Visual Studio to launch server and open your website (e.g., local:8000)

Update RSA Keys

  • Use Izenda's RSA Key Generator Utility Located at http://downloads.izenda.com/Utilities/Izenda.Synergy.RSATool.zip

    1. 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.
    2. And RSAPrivateKey value in appsettings file of the HTML Kit. This value is your private key and should be in PEM format.

Update DeploymentMode value in IzendaSystemSettings table.

e.g. value= 1 (BE Standlaone and FE integrated)

Active Directory Authentication (optional)

If you want to use Active Directory authentication, set useADlogin in appsettings.json value to true.

Initial Log in

  • 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:

DELDG:
Employee Role:

Manager Role:

VP Role:

NATWR
Employee Role:

Manager Role:

VP Role:

RETCL
Employee Role:

Manager Role:

VP Role:

Post Installation

⚠️ In order to ensure smooth operation of this kit, the items below should be reviewed.

Exporting

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


Authentication Routes

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:19657/api/user/validateIzendaAuthToken
AuthGetAccessTokenUrl http://localhost:19657/api/user/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.

Troubleshoot-

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.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages