Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the install example, added registerid06=true.

This article describes how to install Smart ID Desktop App. The commands are issued on each individual computer.

No administrative rights are necessary to install Smart ID Desktop App, and the app does not affect the Windows Registry.


Expandall

Prerequisites

Expand
titlePrerequisites

Install Smart ID Desktop App

Expand
titleInstall Smart ID Desktop App from Microsoft Store
  1. Go to https://www.microsoft.com/store/apps/9P7MDNFPMMDG and download the app.


Expand
titleInstall Smart ID Desktop App from Nexus Support portal
  1. Download the Smart ID Desktop App installation from Nexus Support portal.
  2. To install Smart ID Desktop App:

    1. Run the file Smart ID Desktop App-<version>.msi
      OR

    2. enter the command:

      Code Block
      titleInstall Smart ID Desktop App
      msiexec.exe /i Smart ID Desktop App-<version>.msi [allowcreatevsc=true target=allusers registerid06=true metapath=[json metadata path]]


      Note

      If you shall use the optional parameters you have to run the command as admin


The optional parameters to the msiexec installation are described below.  

ParameterDescription
allowcreatevsc=true

With this option, the administrator gives permanent consent to enable VSC creation.

The consent allows Smart ID Desktop App to carry the whole VSC creation process itself for any (even non -admin) user. There is no longer a need to use the FreeTPM option.

It can also be set with the toggle button Grant permission to create VSCs in advanced settings. See Do advanced settings in Smart ID Desktop App for more information.

Read more technical details here: Smart ID Desktop App installer - technical details

target=allusers

With this option, the administrator gives consent to provision Smart ID Desktop App on the whole machine and accessible for each user (upon next log in).

Read more technical details here: Smart ID Desktop App installer - technical details

registerid06=true 

With this option, the administrator can register Key Storage Provider (KSP) with the ID06 card.

You can also do this in the Smart ID Desktop App GUI, under Advanced Settings by clicking Register key storage provider under the ID06 heading. See step 5 in Do advanced settings in Smart ID Desktop App for more information. 

metapath=[json metadata path]With this option, metadata is imported directly during install. The structure of the .json file is the one used for metadata import via the metadata tool. Read more about the topic here: Smart ID Desktop App metadata tool.

The json metadata path can have one of these forms:

  • metapath="[json file full path]". Beware that in powershell the quotes need to be escaped (the escape character in powershell is ALT+96, i.e the symbol `).
  • or in simplified version metapath=[fileName.json], which can be used if [fileName.json] is saved either in the same folder as the msi or in the current cmd/powershell location.

Uninstall Smart ID Desktop App

Expand
titleUninstall Smart ID Desktop App
  1. To uninstall Smart ID Desktop App enter the command:

    Code Block
    msiexec /i Smart ID Desktop App-<version>.msi [target=allusers] UNINSTALL=true


    Note

    If you shall use the optional parameter you have to run the command as admin


Upgrade Smart ID Desktop App

When you upgrade Smart ID Desktop App, all the metadata, including any existing profiles, are preserved.

Expand
titleUpgrade Smart ID Desktop App from Microsoft Store
  1. Open Microsoft Store.
  2. Click ... (See more).
  3. Select Downloads and update.


Expand
titleUpgrade Smart ID Desktop App from Nexus Support portal
  1. Download the Smart ID Desktop App installation from Nexus Support portal.

  2. Run the file Smart ID Desktop App-<version>.msi.

Troubleshooting

Expand
titleLog files location

You find the log files here:

  1. Open the Event Viewer in Windows.
  2. Go to Applications and Service Logs > Microsoft > Windows > AppXDeployment-Server.
  3. There you find Microsoft-Windows-AppXDeploymentServer/Operational which contains the events.


Expand
titleGenerate msiexec logs

To generate msiexec logs:

  1. Extend the command with "/l log.log", which will produce a log.log file in the current command line location. For example:

    Code Block
    msiexec /i Smart ID Desktop App-<version>.msi [target=allusers] /l log.log



This article is valid for Smart ID Desktop App 1.8.7 and later.

Related information