Nexus Documentation

Space shortcuts

Page tree

Versions Compared

Old Version 20

changes.mady.by.user Ann Base

Saved on

compared with

New Version 21

changes.mady.by.user Josefin Klang

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Smart ID Desktop App 1.12.1 updates

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


Note

There is no longer support for Microsoft Store.

Expandall

Prerequisites

Expand
titlePrerequisites

See Smart ID Desktop App requirements and interoperability.

Install Smart ID Desktop App

Install

  • exe

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 portalNexus Support portal


Note
Administrative rights are required to install the Smart ID Desktop App for all users.
  1. Download the Smart ID Desktop App installation from Nexus Support portal.

  2. To install Smart ID Desktop App:

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

    msi
    OR

    enter the command:

Code Block
title

Uninstall 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.  

ParameterDescriptionallowcreatevsc=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

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.
Expand
titleUninstall Smart ID Desktop App


Note
Administrative rights are required to uninstall the 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.

Uninstall Smart ID Desktop App

Expand
titleUninstall Smart ID Desktop App

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

all users.
  1. Download the Smart ID Desktop App uninstall tool from Nexus Support portal.

  2. To uninstall Smart ID Desktop App, run the Smart ID Desktop App Uninstall.exe file.

    Warning

    Uninstalling the Smart ID Desktop App using this uninstall tool will keep a backup of the metadata and settings,but it will remove the relevant VSC slots, rendering the profile metadata invalid.


Upgrade Smart ID Desktop App

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

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


    Note
    Administrative rights are required to upgrade the Smart ID Desktop App for all users.

    Smart ID Desktop App will upgrade itself every time you run a new version of the installation .exe file, and restore the metadata and settings. No additional upgrade steps are required.

    Troubleshooting

    Expand
    titleUpgrade Verify 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
    installation

    1. Use the following command to verify that the app was provisioned correctly (requires elevation):

      Code Block
      titleVerify provisioned package
      Get-ProvisionedAppxPackage -Online | Where-Object {$_.PackageName -match "nexustechnology"}


    2. The command will return the provisioned package (if the package was provisioned correctly).


    To generate msiexec logs:

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

    Expand
    titleLog files location

    You To 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.

    In addition, an installation or uninstallation log file will be generated on the desktop of the administrator user installing Smart ID Desktop App.

    Expand
    titleGenerate msiexec logs
    Code Block
    msiexec /i Smart ID Desktop App-<version>.msi [target=allusers] /l log.log
    This article is valid

    It will have the name of the executing file with the -log suffix.

    • To redirect the log file to another file use the following command:

      Code Block
      titleRedirect installation log file
      "Smart ID Desktop App-<version>.exe" /l*v! "filename"


    • The redirection applies on uninstalling as well, for example:

      Code Block
      titleRedirect uninstallation log file
      "Smart ID Desktop App Uninstall.exe" /l*v! "filename"


    "filename" can either be a file name, where a log file will be created to where the installation file resides, or a fully path qualified file.

    If the user does not have access to the path and/or the file, the following message will appear:

    Image Added

    This can happen for an administrator as well, if they use a path to a user profile, as they do not have access to it by default.


    Expand
    titleRe-install/re-register Smart ID Desktop App

    If a user has clicked uninstall via start menu, an administrator can register the app for the user again with the following command:

    Code Block
    titleRe-install/re-register Smart ID Desktop App
    Get-AppxPackage -AllUsers *nexustechnology* | ForEach {Add-AppxPackage -DisableDevelopmentMode -Register "$($_.InstallLocation)\AppXManifest.xml"}

    This will register the application if the user uninstalls the application from the start menu, as this will only remove the registration for the user.

    If that fails, try installing the application using the installation .exe file again. The log file produced should contain relevant information if the installation fails.


    Expand
    titleUninstall older versions of Smart ID Desktop App

    The ultimate package command to completely remove any version for all users:

    Code Block
    titleRemove all Smart ID Desktop App packages
    Get-ProvisionedAppxPackage -Online | Where-Object { $_.DisplayName -Match "NexusTechnology" } | Remove-ProvisionedAppxPackage -Online -AllUsers


    Warning

    If you have other products/packages with "NexusTechnology" in the names, these will be removed as well.



    This article includes updates for Smart ID Desktop App 1.812.7 and later1.

    Related information