This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Connectivity Issues

This article covers how to handle connectivity issues.

    The required endpoints are documented in the Endpoint reference.

    Testing connectivity

    The WikiTraccs GUI allows to test the connection to Confluence and to SharePoint. Select the Test Connection buttons to test.

    Messages about blocked connections might look like this:

    Connectivity note

    Connectivity error

    How to handle blocked Google Chrome WebDriver endpoints

    WikiTraccs uses a remote-controlled Chrome browser to execute certain tasks:

    To remotely control Chrome, WikiTraccs needs a WebDriver program which is provided by Google.

    WikiTraccs tries to download the matching WebDriver for the version of Chrome it locates automatically (or for the Chrome binary which is configured to be used via the ChromeBinaryPath setting).

    If auto-detection or download fails then manual configuration is necessary. Specifically two configuration options must be set in a configuration file (sample snippet):

    • ChromeDriverVersionOverride
    • WebDriverDirPath

    Proceed according to the Chrome version that is installed in your environment.

    Determining config values for Chrome version 115 and newer

    Follow these steps to determine the right values for ChromeDriverVersionOverride and WebDriverDirPath which you put into WikiTraccs’ configuration file in a later step:

    1. [on the migration machine] Open the Chrome browser
    2. [on the migration machine] Open Chrome -> (Three Dot Menu) -> Help -> About Google Chrome
    3. [on the migration machine] Take note of the version number (for example 118.0.5993.118)
    4. [on any machine with internet connectivity] Open https://googlechromelabs.github.io/chrome-for-testing/latest-patch-versions-per-build-with-downloads.json in a browser; a web page opens, showing a wall of text
      • On this very page, using the search function of the browser, search for the version number from the previous step minus the last part; so, in this example you search for 118.0.5993 (note: the actual value will be different for you)
      • This search should yield some results, showing more version numbers, which can be different from the Chrome version number
      • Take note of the version value you see there, in the screenshot below it’s 118.0.5993.70 (in the red rectangle) - this is the ChromeDriverVersionOverride value that you need in a later setp:
    5. Using this new 118.0.5993.70 version value you now build the Chrome WebDriver download URL that follows this pattern: https://edgedl.me.gvt1.com/edgedl/chrome/chrome-for-testing/{VERSION_VALUE}/win32/chromedriver-win32.zip
    6. [on any machine with internet connectivity] Using any browser, open above URL in a new browser tab which should start the download of chromedriver-win32.zip
    7. Extract chromedriver-win32.zip and find chromedriver.exe:
      This is the WebDriver.
    8. [only in locked-down scenario] Copy chromedriver.exe from the internet-connected machine to the migration machine
    9. [on the migration machine] Take note of the folder path where chromedriver.exe is stored in; this folder path is the value for WebDriverDirPath, that you’ll need in a later step
      • example path: C:\Users\user\Downloads\chromedriver-win32\chromedriver-win32

    Skip the next section and continue with section How to apply the configuration below.

    Getting config values for Chrome older than version 115

    Follow these steps to determine the right values for * ChromeDriverVersionOverride and WebDriverDirPath:

    1. Open the Chrome browser
    2. Open Chrome -> (Three Dot Menu) -> Help -> About Google Chrome
    3. Take note of the version (e.g. 86.0.4240.75)
    4. Open https://chromedriver.storage.googleapis.com/LATEST_RELEASE_# in a browser, with # replaced by the version from the previous step, minus the last part; so in this example the URL would be https://chromedriver.storage.googleapis.com/LATEST_RELEASE_86.0.4240 (it will be different for you)
    5. A web page opens and shows a single number (e.g. 86.0.4240.22) - this is the value you need to use as value for the ChromeDriverVersionOverride option
    6. Now open https://chromedriver.chromium.org/downloads in a browser and search for the section ChromeDriver # where # is the version from the previous step, which in our case looks like this:

      Find the right ChromeDriver version

    7. Choose the headline which takes you to the download page for this ChromeDriver version:

      Download ChromeDriver for your platform

    8. Download the right zip file for your platform (Windows, Mac or Linux); the zip contains a single file (chromedriver.exe or chromedriver), which is the WebDriver
    9. Extract this single file to a folder; the path to this folder is the value for WebDriverDirPath

    Continue with section How to apply the configuration below.

    How to apply the configuration

    You now have to tell WikiTraccs about the ChromeDriverVersionOverride and WebDriverDirPath values by putting them into WikiTraccs’ appsettings.json configuration file.

    Refer to the Configuration File article for details on how to create appsettings.json and where to store it. Then use the Chromedriver Configuration Sample as template for the file content.

    Now WikiTraccs skips the WebDriver version check and download. This should resolve connectivity issues to the endpoints related to the WebDriver discovery and download.