Upgrading to AVEVA Integration Service 4​.0 and Migrating Data Sources

This section describes how to upgrade an existing AVEVA Integration Service installation to version 4.0, and how to migrate data sources created in earlier versions so that they can continue to be used.

Before You Begin

Ensure the following prerequisites are fulfilled:

Service Upgrade

The AVEVA Integration Service is installed and hosted using IIS. The upgrade process is handled through the installer.

Steps to upgrade:

1. Download AVEVAIntegrationService 4.0.

2. Run the installer on the server where the service is currently installed.

3. The installer automatically removes the previous service, installs the updated service components, and redeploys the service to IIS.

When Data Sources Require Migration

Some data sources created in older versions may require migration because:

• Database schema has changed over versions

• Data sources may now be stored in Cloud Database for CONNECT(Hybrid) deployments

• Each data source is linked to the Device ID of the server

If your previous version is 3.2, data source migration may happen automatically. If your version is older or Device ID changed, follow the appropriate migration path below.

Data Source Migration Scenarios

Determine your migration path based on your current installed version and deployment model:

Note: Data sources of unsupported product versions are not visible post migration.

Migration Procedure Details

4. Migrating data sources when Device ID changes (new server)

   1. Copy the AISDatasources.DB file from the source server.

   2. Move the DB file to the new server.

   3. Run the PowerShell or use AIS APIs to update the Device ID of each data source.

      $global:apiUrl = "https://localhost:60920/config"

      function Get-OSSerialNumber {

      $os = Get-WmiObject -Class Win32_OperatingSystem

      return $os.SerialNumber

      }

      function Invoke-PatchRequest{

      param (

      [string]$product,

      [string]$dataSourceName

      )

      $patchapiUrl = $global:apiUrl + "/products/$product/datasources/$dataSourceName"

      $body = "[{`"op`":`"replace`",`"path`":`"deviceId`",`"value`":`"$global:serialNumber`"}]"

      $headers = @{"Content-Type" = "application/json-patch+json"}

      try {

      $response = Invoke-RestMethod -Uri $patchapiUrl -Method Patch -Body $body -Headers $headers -UseDefaultCredentials

      #Write-Host "API Response after Update:"

      #Write-Host $response

      } catch {

      Write-Host "Error occurred during API request: $_"

      }

      }

      $global:serialNumber = Get-OSSerialNumber

      #Write-Host "OS Serial Number (System Build Number): $global:serialNumber"

      # Create a web request with NTLM authentication and UseDefaultCredentials set to true

      $webRequest = [System.Net.WebRequest]::Create($global:apiUrl)

      $webRequest.Method = "GET"

      $webRequest.UseDefaultCredentials = $true

      $webRequest.PreAuthenticate = $true

      # Send the request and get the response

      try {

      $response = $webRequest.GetResponse()

      $streamReader = New-Object System.IO.StreamReader($response.GetResponseStream())

      $responseData = $streamReader.ReadToEnd()

      $streamReader.Close()

      $response.Close()

      # Parse the JSON response

      $jsonResponse = $responseData | ConvertFrom-Json

      # Extract the 'name' property from each object and add it to the list

      foreach ($item in $jsonResponse) {

      #Write-Host "DataSourceName"+$item.name

      if($item.product.Contains("/")){

      $item.product = $item.product.Replace("/","")

      #Write-Host "Special Character Handled"

      }

      Invoke-PatchRequest -product $item.product -dataSourceName $item.name

      }

      # Display the API response data

      #Write-Host "API Response:"

      #Write-Host $nameList

      } catch {

      Write-Host "Error occurred during API request: $_"

      }

5. Migrating on-prem data sources to AIS CONNECT

   Use the data source migration executable included with the 4.0 installation:

   • AVEVA.AIS.Config.DatasourceMigration.exe

     • DBFile <PathToAISDatasources.DB>

     • DBPWD <DatabasePassword>

     • SAT <ServiceAccessToken>

     • ConfigURL https://eu.ais.connect.aveva.com/config

     • DeviceId <NewServerDeviceID>

   Parameters:

   Parameter	Description
   DBFile	Full path to AISDatasources.DB
   DBPWD	Password applied to database
   SAT	Service Access Token for AIS CONNECT (role: Data Source Admin)
   ConfigURL	Endpoint for AIS CONNECT configuration API
   DeviceId	Device ID to associate migrated data sources with

6. Migrating from earlier versions (earlier than 3.2)

   4. Upgrade your system to 3.1.2.

   5. Upgrade to 3.2.

   6. The installer automatically migrates data sources during the 3.2 to 4.0 upgradation.

7. Migrating from earlier version (earlier than 3.0)

   Contact AVEVA Support to migrate data sources to AIS 4.0.

8. Post-Upgrade Verification

   7. Log into the AIS Administration UI.

   8. Validate that all data sources appear under Data Sources.

   9. Confirm that data source names are unique.