Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Minor updates.

This article describes how to install Nexus Personal Desktop Client on Windows.

MSI-based installers are available for x86 (32-bit) and x64 (64-bit) Windows platforms. The installers include standard operations such as install and uninstall along with the option to install silently.

Expandall

Step-by-step instructions

Expand
titleInstall Personal Desktop Client on Windows
  1. Double-click the appropriate MSI-file for 32-bit or 64-bit Windows.
  2. Follow the instructions in the installer wizard.

After the installation

Expand
titleFile structure

This is the file structure that is created when installing Personal Desktop Client.

DirectoriesContains
-- Personal
  | -- bin

Executables and shared libraries. For example:

  • personal.dll, which containsAPIs for:
    • PKCS#11 (Public-Key Cryptographic Standard) and
    • CSP (Cryptographic Service Provider).
  • minidriver.dll, whichcontains the Microsoft minidriver.
  | -- bin64

64 bit versions of executables and shared libraries. For example:

  • personal64.dll
  • minidriver64.dll
  | -- config

Personal Desktop Client configuration file, personal.cfg. Created when Personal Desktop Client is started the first time.

  | -- docEnd user help files. Includes a sample configuration file.
  | -- storeThe internal software token store. created when Personal Desktop Client is started the first time.

Additional directories and files

  • The cache directory is created in user profile directory when needed (that is, under %APPDATA%\Personal\).
  • Firefox extension are installed into HKLM\SOFTWARE\Mozilla\Firefox\Extensions and native manifest into HKLM\SOFTWARE\Mozilla\PKCS11Modules. This is required for using Personal Desktop Client PKCS#11 in Firefox. You must allow the extension to run the next time Firefox is opened.


Expand
titleShortcuts

Personal Desktop Client installs these shortcuts in the Programs menu:

  • Personal
  • Personal Help

A shortcut is also created under the Startup menu so that Personal Desktop Client will start when logging into the machine.


Expand
titleThe configuration file

The configuration file personal.cfg provides settings for Personal Desktop Client. An example of personal.cfg is shipped with the product, it is included in the doc directory. It includes detailed information and comments.

When you start Personal Desktop Client, a private configuration file is created. The location for the private configuration file is normally Application Data%APPDATA%\Roaming\Personal\config.


Expand
titleList of event log and return codes


Event ID/Return CodeText

2000

<product name> <program version> successfully installed.

2001

Operating system version not supported by installation program.

2002

Installation program requires administrator privileges.

2003

Uninstallation program requires administrator privileges.

2004

A newer version of <product name> exists.

2005

Upgrade of <product name> declined.

2006

Reinstall of <product name> declined.

2007

Upgrade started.

2008

Upgrade failed.

2009

Uninstallation started.

2010

Current installation of <product name> cannot be upgraded to current version (<program version>). Uninstall it and run this installation program again.

2011

Uninstallation started, no installation to uninstall.

2012

Installation started with unknown arguments.

2013

Installation of <product name> is already running.

2014

Failure communicating with operating system.

2015

Out of memory.

2016

Failed to create installation directory.

2017

Failed using temporary directory for installation.

2018

Modular upgrade installation does not support switch given to modular upgrade program.

2019

Modular upgrade successfully performed.

2020

Modular upgrade requires administrator privileges.

2021

<product name> not installed, modular upgrade cannot be performed.

2022

Modular upgrade of <product name> declined.

2023

Modular upgrade of <product name> denied. Installed version of <product name> was not <program version>.

2024

Uninstallation of <product name> successful.

2025

Uninstallation of <product name> successful. Reboot needed.

2026

Installation could not proceed due to problems regarding an existing installation.

2027

Modular upgrade could not proceed due to problems regarding an existing installation.

2028

Operating system version no longer supported by installation program.

2029

Installation could not proceed since a Personal Desktop version with incompatible classification is already installed on the system.

4000

Installation of <program version> failed. Contact support.


Uninstall Personal Desktop Client

Expand
titleUninstall Personal Desktop Client on Windows
  1. To uninstall Personal Desktop Client:

    • Use the Add/Remove programs buttons

      or

    • Execute the UninstallString defined by the registry key 

      Panel
      borderStylenone

      HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\Personal


  2. If files are locked during uninstallation, the installation program will install itself into the location specified by

    Panel
    borderStylenone

    HKEY_CURRENT_USER\Software\Microsoft\Windows \CurrentVersion\RunOnce

    and remove the locked files at next reboot.


This article is valid from Nexus Personal Desktop Client 5.1.

Related information