Install web services for IMPACT 17.2
Server Requirements for IMPACT 17.2
.NET 8.0 - ASP.NET Core Runtime
To download the installation files for .NET 8.0 - ASP.NET Core Runtime & .NET 8.0 - ASP.NET Core Runtime - Hosting bundle go to this link:
https://dotnet.microsoft.com/en-us/download/dotnet/8.0
Start by downloading the .NET 8.0 - ASP.NET Core Runtime for Windows 8.0.21 or Newer (1), the .NET 8.0 - ASP.NET Core Runtime—Hosting bundle 8.0.21 or Newer (2), and then the .NET 8.0 - ASP.NET Core Desktop Runtime 8.0.21 or Newer (3).
Figure1: Download .NET 8.0
Run both installation files to make the server ready for migration
Figure2: Install .NET 8.0
Web Deploy 4.0
To download the installation file for Web Deploy 4.0 go to this link:
https://www.microsoft.com/en-us/download/details.aspx?id=106070
Click on Download (1) and select "webdeploy_amd64_en-US.msi" (2).
Figure 3: Download Web Deploy v4.0
When the file is downloaded run the installation file to make the server ready for migration
Figure 4: Install Web Deploy v4.0
SQL Server 2016 Compatibility Level 130
Before it's possible to migrate the IMPACT Database to 17.2 should the database have the compatibility level SQL Server 2016 (130) or newer.
The Compatibility level can be set under the database properties (1) -> Options (2) -> Compatibility Level (3).
Figure 5: SQL Database Compatibility level
Installing and Deploying the WebAPI.
The IMPACT Service Configuration is used to deploy the services on the server so the client computers can communicate with the IMPACT database. Its also used to migrate the IMPACT database when newer versions of IMPACT are released (Eg IMPACT 17.2).
Start by installing the Service Configuration from the StruSoft Installer. You can find the application through the filter in the IMPACT tab, select the Server
Figure 6: Service Configuration in Strusoft Installer
Please note! Service Configuration has dependencies and requires redistributables. If the server is waiting for a Windows update, the installation of a new version of Service Configuration could result in a reboot of the server. Therefore, installs/updates of the tool should be carried out outside working hours.
Using the Service Configuration to deploy the services
The Service Configuration will help you deploy (install) IMPACTs web services. In order to run the Service Configuration tool - Run the application as Admin.
The first page that will show is the instructions - Click on "Instructions" to exit the information view.
Figure 7: Instructions in Service Configuration
Creating a new Site & Application Package
Start by clicking on "New" to create a new site and give the site a name and an available port.
Figure 8: New site in Service Configuration
Figure 9: Creating a new site
When the site is created add an Application Package by clicking on Add - And give the Application Package a name (In this example IMPACT 17 Local.)
Figure 10: Creating a new Application Package.
Database Connection Settings
When the Application Package is created start by adding the "Database connection" information.
Figure 11: SQL Server name & SQL Database Instance in IMPACT Service Configuration
The SQL Server and SQL Database Instance can be found in the Microsoft SQL Server Management Studio on the server where the IMPACT Database is placed.
The server name is the name before the brackets. In this case DESKTOP-K3QNNRI.
Figure 12: SQL Server name
The database is located under databases. In this case IMPACT_17.
Figure 13: SQL Database Instance
WebAPI Credentials and Deploying
The IMPACT Service Configuration needs to have a user in the SQL Server that is allowed to modify the IMPACT Database.
Figure 14: WebAPI Credentials in IMPACT Server Configuration
In this case, the user is called the "IMPACTServiceUser" - This user is used to communicate with the IMPACT Database. The User Id & Password are created and found in Microsoft SQL Server Management Studio. Right-click on Logins (1) under Security and select New Login... (2)
Figure 15: New Login.
Under the page General, you choose your Login name (1) and your password (2). Box SQL Server authentication (3) and unbox Enforce password policy (4).
Figure 16: New Login - General.
Under the page User Mapping (1), choose your database (2) and box strusoftServiceRole (3), StrusoftDBARole (3) db_datareade (4) & db_datawriter (4). It's important that the user has an elevated role to be able to communicate with the IMPACT Database.
Figure 17: New Login - User Mapping.
When the user has been added to the IMPACT Service Configuration - Click Test Connection to make sure that the users can connect to the IMPACT Database.
Figure 18:Test connection in IMPACT Server Configuration
Now when the connection to the Server Instance is established is it time to deploy the Web API.
If the IMPACT Database is 17.1 or lower is it also needed to do a Migration of the IMPACT database. The additional steps for migrating can be found under "Migration of the IMPACT Database".
Figure 19: WEB API Deployment in IMPACT Server Configuration
1) Start by marking the checkbox so the Service Configuration knows that it should deploy the newest Web API.
2) The Application Name is the name of the connection that should be added to the server connect to establish the connection between the client computer and the IMPACT Database. The name may not be the same as the Application Packages (In this example IMPACT 17 Local)
3) The API Key is set on the StruSoft Portal and managed by the "Customer Admin" of the company. Contact the "Customer Admin" to get the API Key.
4) Finish by clicking "Deploy" at the top.
NOTE: It's important to set up the Cloud Storage and Automatic Notification before deploying if this should be used.
Figure 20: Deployed Successfully in IMPACT Server Configuration
The Installed - Latest should now be the same version.
Figure 21: Installed - Latest in IMPACT Server Configuration
Migration of the IMPACT Database
Migrating an IMPACT Database to a new version is done in the IMPACT Service Configuration and are using the "Migration System Credentials" and the "Migration System".
NOTE: The information under Database Connection, Web API Credentials & Web API should also be filled in because the migration will be performed during the deployment of the Web API.
Figure 22: Migration System Credentials & Migration System in IMPACT Server Configuration
The "user" that will be used to migrate is a login in the SQL Server and needs full access to the database instance. The reason that the user needs full access is that the migration modifies the IMPACT Database by adding new tables to the IMPACT Database.
Make sure that this user has the extended database role that you can require a script from StruSoft about.
Mark Enable Migration under Migration System and enter the Migration Key. The Migration Key is a password so not everyone can start a migration - This Key will be applied when migrating from IMPACT 17.1 to 17.2 and should be used when migrating to future IMPACT versions. So keep it safe.
If this Key should get lost can it be found in the IMPACT Database under the table called [system].[DATABASE_VARIABLE]
Figure 23: Migration Key in the IMPACT Database
When the things have been set click on Deploy at the top to start the migration
Figure 24: Migrating in IMPACT Server Configuration
The first thing that will show is a warning - Only click Yes to this warning if a backup of the IMPACT Database has been taken.
Figure 25: Migrating warning in IMPACT Server Configuration
After some time will the migration and deployment be done and the IMPACT Database will be ready to use IMPACT 17.2.
Figure 26: Migrating & deploying were successful
File Sync and Publish Cloud Storage
File Sync, Publish, Rejection and disorder use attachments. These attachments can be binary files (pictures, DWG files) or Zip files (Publish) - And will be stored on Cloud Storage.
The attachments can be saved on one of the following storage types:
- FTP (Read here to get mere information on how to set up an FTP Cloud storage)
- Amazon web Services
- Azure
Figure 27: File Sync & Publish Cloud Storage in IMPACT Server Configuration
Automatic Notification
To be able to use the Notification feature is it necessary to have a mail server configured. This needs to afterwords be filled into the Service Configuration.
Figure 28: Automatic Notificaiton in IMPACT Server Configuration