Skip to content

Installing the client applications

Info

The standard installation includes the UserClient, AdminClient, EasyClient and ReportClient clients. Optional with this installation are the BackupClient and the LibraryManagement. To install the optional client applications afterwards, uninstall the client applications first and then install them altogether using the setup file.

Previous to the installation

Decide where (together with the server or separately) the client applications are to be installed. The BackupClient can not be installed on the same computer where the server is running.

Decide if the optional client applications, BackupClient and LibraryManagement, are to be installed (step 7).

Installation requirements for mounted drives

We recommend that you do not install the client archive on a mounted drive. Should you have to, please be aware of the following:

  1. If the client archive will be installed in a directory that requires elevated rights (write rights) and the setup is run as administrator, the mounted drive on which the client archive will be located must be mounted for the user and for the administrator account.
  2. When carrying out a Smartupdate, the setup must be run as administrator if the installation directory requires elevated rights (write rights). The client archive must also be mounted for the administrator if it is mounted for a standard user.

Procedure

  1. Execute the Setup.exe file as administrator

    Info

    In Windows 10, the desktop shortcuts of the octoplant 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.

  2. The installation wizard is then started. In the first dialog, select the language.

  3. No action is required on the welcome page, read the text and select Next.

  4. In the next dialog, select Install octoplant applications.

    Figure: Installation wizard, installing octoplant applications

  5. Select Next.

  6. In the license agreement dialog, select I agree. so that you can continue with the installation.

  7. In the next dialog, Install client applications is already preselected.

    Figure: Installation Wizard, installing clients

  8. Select Next.

  9. Select the desired options in the next dialog:

    Figure: Installation wizard, selection of program extensions

    Options:

    • BackupClient
      The BackupClient is used to perform data backups for automation devices that the octoplant system cannot otherwise access. This option is available at no extra charge. If you install the BackupClient but never use it on this computer, this has no negative effects. Subsequent installation of the BackupClient is possible at any time. The BackupClient cannot be installed on the computer on which the octoplant server is running.

    • LibraryManagement

      LibraryManagement is an application for version management of standard blocks and is currently available for Siemens S7, Siemens TIA Portal and RSLogix 5000.

      LibraryManagement can be installed at a later date at any time.

    • Register file extension for SmartImport for supplier projects

      This option allows you to send octoplant projects by email to suppliers and customers who do not use octoplant or do not have access to your octoplant server.

      If the option is activated, an entry is written in the Windows registry that allows a octoplant delivery bill for suppliers (file type *.vdog-sdn) to be opened in the file manager. If the option is not activated, no registry entry is written and file types *.vdog-sdn can only be opened using the UserClient.

      The registration of the file extension can also be made or undone in the UserClient. This is located in the Client settings dialog in the Extensions tab.

    • Register protocol extension to start octoplant via web link

      If you have activated this option, you can start the UserClient using a web link in the browser. The web link has the format vdog:cid/{CID}, whereas {CID} is the component ID of the system.

      You can also register or deregister the protocol extension in the UserClient. This is located in the Client settings dialog in the Extensions tab.

  10. Select Next.

  11. In the next dialog, either accept the default path for the client application directory or enter a path of your choice. If the path to the octoplant server application directory is displayed in gray, it is inactive. If you specify a different path, please note 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 must specify a target directory for the client applications (vdogClient by default).
    • The target directory must only contain the client applications.
    • Do not select the Desktop as the target directory (exclusive use would not be given here).
    • Do not select the Programs folder as the target directory (exclusive use would not be given here).

    Info

    In order for SmartUpdates to be carried out, the user requires write access to the installation folder of the client applications. As of Windows 7, only administrators have write access to directories under C:\Program Files\ by default. Either grant the user write permissions to the folder C:\Program Files\vdogClient or select an installation path to which the user has write permissions (for example, C:\vdClientArchive\Client\), so that SmartUpdates can be performed.

  12. Select Next.

  13. In the next dialog Path to local client archive:, either accept the default path or enter a path of your choice. The client archive directory must be located on a local drive on your computer. We recommend a directory to which all users working on this computer have access and for which no administrative rights are required. If you have installed the BackupClient, the dialog Path to the local backup archive (of the BackupClient) is activated and you can accept or adjust the path to the backup archive in the same way.
  14. Select Next.

  15. In the next dialog, the option to grant the Windows user group Everyone access to the client archive is selected by default - otherwise deactivate this option.

    Figure: Installation wizard, setting rights for client archive

  16. Select Next.

  17. In the next dialog, decide which shortcuts you want to install for the client applications:

    Figure: Installation wizard, selecting shortcuts

    Info

    Under Windows 10, the desktop shortcuts of the client applications are displayed for all users of a computer when the Setup.exe program is started with the Run as administrator option (provided that the shortcuts were created during installation - see step 11). If this option is not selected, the desktop shortcuts will only be displayed for the user who has run the program Setup.exe.

  18. Select Next.

  19. The locations specified for the Program files and the client archive are displayed for you to check:

    Figure: Installation wizard, summary

  20. Select Next to start the installation.

  21. To complete the installation of the client applications, the Installation successful! dialog is displayed.
  22. Select Finish.

FAQ

Changing the storage location of the client archive

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

  1. Close all octoplant applications.
  2. Copy the client archive to the desired location (for example, E:\vdClientArchive).

  3. Enter the desired storage location, for example D:\Programme\vdogClient\VDogClient.exe" /at:C"/rd:E:\vdClientArchive as Target in the Properties for all octoplant shortcuts (right-click -> Properties -> Link tab -> Target field).

  4. Login to a client application as usual. The new location for the client archive will now be used.

Unique client archive for each user on a shared system

No more than one client can work with a client archive (i.e. each client needs its own archive), to which it has exclusive access. If you want the users to work in parallel with a single client installation, each user needs its own client archive.

Adapt the properties of the octoplant clients, proceed as follows:

  1. Install the octoplant client applications.

  2. Right-click on the octoplant client applications: UserClient, EasyClient, AdminClient, ReportClient.

  3. Click on Properties in the application window.

  4. In the Link tab, adjust the directory, for example:
    C:\Program files\vdogClient\VDogClient.exe" /at:C"/rd:%USERPROFILE%\vdClientArchive

For systems such as Citrix, all other links of the octoplant client applications on the terminal server must also be changed. To do this, go to C:Users\Public\Public Desktop on the terminal server and adjust all octoplant shortcuts.

Using octoplant on a terminal server

Yes, octoplant can be used on a terminal server.

To be able to use octoplant on a terminal server, the shortcuts of the client applications UserClient, AdminClient, ReportClient must be adapted:

  1. Right-click on the shortcut of a octoplant client.
  2. Select the Properties entry.

  3. In the Shortcut tab, adjust the directory, example:
    C:\Programme\vdogClient\VDogClient.exe /at:c"/rd:%USERPROFILE%\vdClientArchive"

  4. The shortcuts of the octoplant clients on the terminal server must then be adjusted accordingly. To do this, go to C:\Users\Public\Public Desktop in the terminal server and adjust all octoplant shortcuts as explained above.