Installation - step by step guide

  1. Open the versiondog client setup directory and execute the program Setup.exe. Select the option execute as administrator by right clicking on the file.
  2. In Windows 10, the desktop shortcuts of the versiondog client applications are displayed for all users of a computer, if the program Setup.exe is started with the option execute as Administrator (provided that the shortcuts were created during installation- see step 11). If this option is not selected, the desktop shortcuts are displayed only for the user who ran the Setup.exe program.

  3. The installation wizard will then start. In the first dialog, select the language.
  4. On the welcome page of the setup wizard, no steps are required. Read the text and then click on Next.
  5. Then in Install versiondog applications, click on Next.

    Image: Installation wizard, Installation versiondog applications
  6. In the License Agreement dialog box, select I agree to proceed with the installation.
  7. Then select Install client applications and click on Next.

    Image: Installation wizard, Installing Clients
  8. In the next dialog box, select from the following options:

    Images: Installation wizard, selection of program extensions
  9. Options:


    The BackupClient is used to make backups for automation devices that can only be accessed by the versiondog system. For more information, see BackupClient.

    This option is available at no extra cost. If you now install BackupClient but never use it on this PC, this will have no negative effects. It is always possible to install the BackupClient at a later date.

    The BackupClient cannot be installed on the machine on which the versiondog server is running.


    The LibraryManagement is a version management tool for standard blocks and currently available for Siemens S7, Siemens TIA Portal and RSLogix 5000. For more information, see the LibraryManagement tutorial.

    The LibraryManagement is an add-on and therefore requires a separate license.

    If you install LibraryManagement without a license, this will have no negative effects. When you call up LibraryManagement, you will receive a message informing you that this function is not included in your license. A subsequent installation of LibraryManagement is possible at any time.

    Register file extension for SmartImport for supplier projects

    This option allows you to send versiondog projects via email to suppliers and customers who do not use versiondog or do not have access to your versiondog server. For more information, see the UserClient tutorial, section Working with external programmers.

    If the option has been activated, an entry will be written into the Windows Registry, which makes it possible to open a versiondog delivery bill for suppliers (file of the type *.vdog-sdn) in the file manager. If the option has not been enabled, no registry entry will be written and files of type *.vdog-sdn can be opened only through the UserClient.

    The registration of the file extension can also be done or undone in the UserClient, in the Client Settings dialog, located under the Extensions tab.

    Register protocol extension to start versiondog via web link

    If you have enabled this option, you will be able to start the UserClient from the browser via a weblink. The weblink has the format vdog:cid/<CID>, where <CID> is the component ID of the system.

    The registration of the protocol extension can also be done or undone in the UserClient, under the Client Settings dialog in the Extensions tab.

  10. In the next dialog, either accept the default path for the versiondog client applications directory or specify a path of your choice.

    If the path to the directory is being displayed in grey, it is not active.

    When entering another path, please pay attention to the following:
    • The applications cannot be installed in the root directory of a drive (there must therefore be at least one directory in the path).
    • You need to specify a target directory for the client applications (vdogClient by default).
    • The target directory may only contain the versiondog client applications.
    • Do not select the Desktop as the target directory (an exclusive use would not be possible here).
    • Do not select the file Programm as the target directory (an exclusive use would not be possible here).
    To enable SmartUpdates to be carried out, the user will require write access to the installation file on the versiondog client application. From Windows 7 onwards, only administrators have write access to directories located under C:\Programm\. To enable SmartUpdates to be carried out, ssign the user either write access to the file C:\Programme\vdogClient or select the installation path to which you want the user to have write access to (e.g. C:\vdClientArchive\Client\).
  11. In the next dialog box Path to local client archive, either accept the default path for the versiondog client application directory or enter a path of your choice. The client archive directory must be located on a local drive of your computer. Once you have installed the BackupClient, the dialog Path to the local backup archive (of the BackupClient) is enabled and you can now accept or modify the path to the BackupClient in the same way.
  12. In the next dialog, the option to grant the Windows user group All users access to the versiondog client archive is selected by default - otherwise deactivate this option.

  13. Image: Installation wizard, Set rights for client archive

  14. In the next dialog, you will need to decide which shortcuts you want to install for the versiondog client applications:

    Images: Installation wizard, Select shortcuts
  15. The storage location, that has been selected for program files and the client archive, will be displayed for you to check:

    Images: Installation wizard, summary
  16. Start the installation by clicking on Next.
  17. Once the client application has been successfully installed, the dialog Installation successful! will be displayed. Click on Finish.

FAQ: How do I change the directory in which the client archive is stored?

To change the directory of the client archive, proceed as follows:

  1. Close all versiondog applications.
  2. Copy the vdClientArchive to the desired directory (for example: E:\vdClientArchive)
  3. Change the target in the settings of all versiondog links.
    1. To do this, right-click on the versiondog shortcut.
    2. Select the menu item configuration.
    3. In the Shortcut tab, enter the desired location in the field Target , e.g. D:\Programs\vdogClient\VDogClient.exe" /at:c "/rd:E:\vdClientArchive.
  4. Log on to a client application as usual. The new location for the client archive is now used.

To FAQ list


FAQ: How do I configure versiondog if the client archive has to be located on a shared drive?

If the client archive is on a network share (for example, if you are working with Citrix), proceed as follows:

  1. Install the versiondog client applications.
  2. Important: Set up the program directory and the client archive as a network share.

    No more than one client can work with any one client archive (i.e. each client needs a separate archive to which it has exclusive access).

  3. Copy the server settings to the client's program directory (...:\Program Files (x86)\vdogClient):
    1. Go to the directory <Drive:>\vdServerArchive\VD$A\Configuration\Firebird.
    2. Copy the file firebird.conf into the versiondog client’s program directory.
    3. Open the file firebird.conf in the program directory.
    4. Change the line "#RemoteFileOpenAbility = 0" to "RemoteFileOpenAbility = 1".
  4. Customize the shortcuts of the versiondog client applications (UserClient, AdminClient, ReportClient):
    1. Right-click on the shortcut of the versiondog application.
    2. Click on Properties in the application window.
    3. In the Shortcut tab, adjust the directory, e.g:
    4. C:\Programme\vdogClient\VDogClient.exe /at:C "/rd:%USERPROFILE%\vdClientArchive"
    5. The versiondog client application shortcuts on the terminal server also have to be changed. In order to do this, go to C:Users\Public\Public Desktop in the terminal server and customize all versiondog shortcuts.

To FAQ list

Related topics:
First call– important information on server configuration
FAQ: The process failed when I tried to install the versiondog server. Why has this happened?