Skip to main content

Insight API - Installation Guide

Download and extract the artifacts​

The file which contains the Insight Api will be called InsightsApi.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.

Insight API files​

The InsightsApi.zip file contains the following files:

  • Bliksund.EWA.Insights.Api.Parameters.xml - Contains the definition of the parameters that can be set. Includes how the deployment handles the parameters.
  • Bliksund.EWA.Insights.Api.SetParameters.xml - Contains the values for the parameters that should be set when running deployment.
  • Bliksund.EWA.Insights.Api.SourceManifest.xml - Contains the definition of the files that should be included in the deployment.
  • Bliksund.EWA.Insights.Api.deploy-readme.txt - Contains information about the deployment.
  • Bliksund.EWA.Insights.Api.deploy.cmd - Contains the deployment script.
  • Bliksund.EWA.Insights.Api.zip - Contains the application files.

Edit the Insight API parameters​

Edit the file Bliksund.EWA.Insights.API.SetParameters.xml with suitable values in your system or copy the values from the file used in the last build.

ParameterDescriptionExample
ConnectionStrings__InsightDbThe connection string to the database that the Api should use.Data Source={Database Server};Initial Catalog={Database Name};User ID={Database Administrator};Password={Database Administrator Password};Pooling=False;MultipleActiveResultSets=True;Application Name=InsightApi
Services__AnalyticsService__AuthKeyThe API key that the Analytics API use to authenticate (This module has not been released yet, it should be manually removed).
Services__AnalyticsService__UrlThe internal URL to interact with Analytics API (This module has not been released yet, it should be manually removed).
LogSettings__SqlDb__ConnectionStringThe 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 API​

We use the Bliksund.EWA.Insights.API.deploy.cmd script to deploy the new api. It will use the parameters defined in the Bliksund.EWA.Insights.API.SetParameters.xml file to deploy to the IIS website defined in the IIS Web Application Name parameter.

  1. Open the command prompt and run the command Bliksund.EWA.Insights.API.deploy.cmd /T to see what changes will be applied to the file system. Please note this command should be ran under administration permission.

  2. Then run the command Bliksund.EWA.Insights.API.deploy.cmd /Y to do the actual changes. You will see the change applied under the website on IIS.

Make sure the Insight API is running​

Once the Api has been deployed, make sure that it is running by navigating to the URL /healthz endpoint in a web browser.

For example: {yourWebsiteUrl}/InsightsApi/healthz

The Api should return a 200 OK response with the body Healthy.

Set the Insight API parameters in Insight​

To Insight to be able to use the Insight Api, the URL must be set in the Insight parameters.

ParameterDescriptionExample
Insights Api UrlThe URL to the Api.https://dev.ewa.bliksund.com/InsightsApi