Insight Web - Installation Guide
Download and extract the artifacts
The file which contains the Insight Web will be called InsightsWeb.zip and can be found together with the other release files for EWA.
Once the file has been downloaded, extract the contents of the zip file to a temporary location on the server.
The InsightsWeb.zip file contains the following files:
Bliksund.EWA.Insights.Web.Parameters.xml- Contains the definition of the parameters that can be set. Includes how the deployment handles the parameters.Bliksund.EWA.Insights.Web.SetParameters.xml- Contains the values for the parameters that should be set when running the deployment.Bliksund.EWA.Insights.Web.SourceManifest.xml- Contains the definition of the files that should be included in the deployment.Bliksund.EWA.Insights.Web.deploy-readme.txt- Contains information about the deployment.Bliksund.EWA.Insights.Web.deploy.cmd- Contains the deployment script.Bliksund.EWA.Insights.Web.zip- Contains the application files.
Edit the Insight Web parameters
Edit the file Bliksund.EWA.Insights.Web.SetParameters.xml with suitable values in your system.
<?xml version="1.0" encoding="utf-8"?>
<parameters>
<setParameter name="IIS Web Application Name" value="Default Web Site" />
<setParameter name="ConnectionStrings__InsightDb" value="Data Source={Database Server};Initial Catalog={Database Name};User ID={Database Administrator};Password={Database Administrator Password};Pooling=False;MultipleActiveResultSets=True;Application Name=InsightApi" />
<setParameter name="Insights Api Url" value="" />
<setParameter name="Integration Url" value="https://localhost/emccintegration" />
<setParameter name="Integration API Key" value="" />
<setParameter name="LiveviewApi Path" value="https://localhost:61641/" />
<setParameter name="FormModuleAPI Path" value="https://localhost:62636/" />
<setParameter name="FormModule Api Key" value="" />
<setParameter name="ChatServer Endpoint" value="{ChatServer__Endpoint}" />
<setParameter name="ChatServer Api Key" value="{ChatServer__ApiKey}" />
<setParameter name="LiveVideoUrl" value="" />
<setParameter name="LiveVideoAuthKey" value="" />
<setParameter name="VersionManager Api Url" value="" />
<setParameter name="VersionManager Api Key" value="" />
<setParameter name="Personnel Registration Api Url" value="" />
<setParameter name="Personnel Registration Api Key" value="" />
<setParameter name="LogSettings__SqlDb__ConnectionString" value="Server={Database Server};Database={Database Name};User Id={Database Administrator};Password={Database Administrator Password};Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100;" />
</parameters>
| Parameter | Description | Example |
|---|---|---|
| IIS Web Application Name | The name of the IIS Web Application that the component should be installed to. Should be in format {SiteName}/{WebAppPath} where {SiteName} should be the name of the IIS site the webapp should use, and {WebAppPath} is the path of the webapp under the site. | BliksundPEPJ/Insight |
ConnectionStrings__InsightDb | The connection string to the database should be used by the Insight Web. | Data Source={Database Server};Initial Catalog={Database Name};User ID={Database Administrator};Password={Database Administrator Password};Pooling=False;MultipleActiveResultSets=True;Application Name=InsightApi |
| Insight Api Url | The URL to the deployed Insight API component. | |
| Integration Url | The URL to the deployed Integration component. | https://myewaserver.com/integration |
| Integration API Key | The API key that the Integration component is configured with. If the Integration component is not configured with an API key, this line can be deleted. | REDACTED |
| LiveviewApi Path | The URL to the deployed LiveView API component. | https://myewaserver.com/liveview |
| FormModuleAPI Path | The URL to the deployed FormModule API component. | https://myewaserver.com/formmodule |
| FormModule Api Key | The API key that the FormModule API component is configured with. | REDACTED |
| ChatServer Endpoint | The URL to the Chat server. | https://myewaserver.com/ChatServer |
| ChatServer Api Key | The API key that the Chat server is configured to use. | [REDACTED] |
| VersionManager Api Url | The URL to the deployed VersionManager API component. | https://myewaserver.com/versionmanager |
| VersionManager Api Key | The Website API key that the VersionManager API component is configured with. | REDACTED |
| Personnel Registration Api Url | The URL to the deployed PersonnelRegistration API component. | |
| Personnel Registration Api Key | The API key that the PersonnelRegistration Api is configured to use.. | |
LogSettings__SqlDb__ConnectionString | The connection string to the database use to storage logs, it can be the same with the main database if there is no need for distributed log storage. | Server={Database Server};Database={Database Name};User Id={Database Administrator};Password={Database Administrator Password};Encrypt=True;TrustServerCertificate=False;Connection Timeout=30;Max Pool Size=100; |
Deploy the Insight Web
We use the Bliksund.EWA.Insights.Web.deploy.cmd script to deploy Insight Web. It will use the parameters defined in the Bliksund.EWA.Insights.Web.SetParameters.xml file to deploy to the IIS website defined in the IIS Web Application Name parameter.
- Open the command prompt and run the command
Bliksund.EWA.Insights.Web.deploy.cmd /Tto see what changes will be applied to the file system. Please note that this command should be run under administrative permission. - Then run the command
Bliksund.EWA.Insights.Web.deploy.cmd /Yto do the actual changes. You will see the change applied to the IIS website.