Personnel Registration - Installation Guide

The new personnel registration module in Insight allows for role pre-configuration within the platform. Designed for ease of use, it offers a comprehensive management solution with a straightforward interface for efficient information retrieval.

Download and extract the artifacts

The file which contains the Personnel Registration Api will be called PersonnelRegistrationApi.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.

Personnel Registration Api files

The PersonnelRegistrationApi.zip file contains the following files:

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

Edit the Personnel Registration Api parameters

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

Parameter	Description	Example
IIS Web Application Name	The name of the IIS website that the Api should be deployed to.	https://dev.ewa.bliksund.com/PersonnelRegistrationApi to deploy the PersonnelRegistrationApi path under the dev.ewa.bliksund.com site.
ConnectionStrings__PersonnelRegistrationDatabase	The 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=EntityFramework
Authorization__ApiKey	The API key that the Api should be configured to use.	[REDACTED] This supports almost any string, but it is recommended to use a generated value with a high entropy.
CorsPolicy__AllowedOrigins	String of comma separated origins to allow through CORS policy.	""

Deploy the Personnel Registration Api

We use the Bliksund.EWA.PersonnelRegistration.WebApi.deploy.cmd script to deploy the new api. It will use the parameters defined in the Bliksund.EWA.PersonnelRegistration.WebApi.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.PersonnelRegistration.WebApi.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.PersonnelRegistration.WebApi.deploy.cmd /Y to do the actual changes. You will see the change applied under the website on IIS.

Make sure the Personnel Registration 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}/PersonnelRegistrationApi/healthz

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

note

The /healthz endpoint path has been chosen instead /ping because this is one of the three standard paths used by Kubernetes for health checks.

Set the Personnel Registration Api parameters in Insight

To Insight to be able to use the Personnel Registration Api, the URL and API Key must be set in the Insight parameters.

Parameter	Description	Example
Personnel Registration Api Url	The URL to the Api.	https://dev.ewa.bliksund.com/PersonnelRegistrationApi
Personnel Registration Api Key	The API key that the Api should be configured to use.	[REDACTED] This must be the API Key that was set during deployment.