Table of Contents

Preparing to debug on a remote DataMiner Agent

Proceed as follows if you want to debug a QAction or an Automation script located on the DataMiner Agent that is running on another machine.

  1. On the remote DataMiner Agent, create a network share where DIS can upload the DLL files and the symbol files.

    Example: C:\dis

  2. When you use Visual Studio 2010, both Visual Studio and Remote Debugging Monitor (msvsmon.exe) need to run with a local Administrator account. Create a dedicated debugging user account on your local computer as well as on the remote DataMiner Agent. Make sure both user accounts have:

    • the same name (e.g. "RemoteDebug"),
    • Administrator rights, and
    • access to the network share mentioned in step 1 (Read and Change permissions).
    Note

    As from Visual Studio 2012, Remote Debugging Monitor (msvsmon.exe) can run with any user account that has Administrator rights.

  3. Copy or install Remote Debugging Monitor (msvsmon.exe) on the remote DataMiner Agent.

    • To install Remote Debugging Monitor on the remote DataMiner, either download and run the installer, or copy all files from the following local folder to a random folder on the remote DataMiner Agent:

      Visual Studio version Local folder
      prior to VS 2017 C:\Program Files (x86)\Microsoft Visual Studio XX.X\Common7\IDE\
      Remote Debugger\x86
      Example:
      C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\
      Remote Debugger\x86
      as from VS 2017 C:\Program Files (x86)\Microsoft Visual Studio\<version>\Professional\
      Common7\IDE\Remote Debugger\x86
      Example:
      C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\
      Common7\IDE\Remote Debugger\x86
      Note
      • Make sure that the version of Remote Debugging Monitor on the remote DataMiner Agent is the version supplied with the version of Visual Studio you are using on your local computer.
      • Always use the 32-bit version of Remote Debugging Monitor.

  4. On the remote DataMiner Agent, log on with the dedicated debugging account you created in step 2 (e.g. "RemoteDebug"), and start Remote Debugging Monitor as an Administrator.

    • Make sure Remote Debugging Monitor uses "Windows Authentication". To check this setting, go to Tools > Options.
    Note

    It might be necessary to change certain firewall settings.

  5. Run Visual Studio as an Administrator.

  6. Make sure that, in the DMA tab of the DIS Settings window, you have added the DataMiner Agent with the correct user account and that, in its Debugging tab, you have selected the Enable remote debugging option and configured the following settings:

    Setting Description
    Publish path The network path to the shared folder on the remote DMA where DIS will upload the DLL files and the symbol files.
    Default: \\remote-dma\dis
    Path on DataMiner The local path to the shared folder on the remote DMA where DIS will upload the DLL files and the symbol files.
    Default: C:\dis\
    Debugger qualifier The qualifier supplied by Remote Debugging Monitor (msvsmon.exe) in a log entry at start-up.
    Format:
    - username@dmaname (Visual Studio 2010)
    - dmaname:ipport (as from Visual Studio 2012)
    Default: RemoteDebug@remote-dma

    See DMA

  7. Go to Tools > Options > Debugging > Symbols, and add the above-mentioned "publish path"
    (e.g. \\remote-dma\dis) to the list of symbol file locations.

You are now ready to start debugging. See Debugging a connector or Debugging an Automation script.

Propose changes