- This line was added.
- This line was removed.
- Formatting was changed.
This article describes the Smart ID Desktop App (Personal Desktop App) metadata metadata tool. The tool is available for download from version 1.3.5 of Smart ID Desktop App.
With the tool you can gather information about Smart ID Desktop App metadata for backup or in order to investigate issues with Smart ID Desktop App. The tool also allows you to easily modify Smart ID Desktop App settings. This can be used to customize Smart ID Desktop App settings directly with the app installation, or to restore it.
The tool is not a part of the installation, but can be downloaded from the same area that Smart ID Desktop App is downloaded from (Nexus Support portal).
Since version 1.4.0 of Smart ID Desktop App, there are two versions of the app:
- store - Smart ID Desktop App is downloaded from Microsoft Store
- sideload - Smart ID Desktop App is downloaded from Nexus Support portal and installed with sideloading enabled
The metadata tool works with bort versions of the app, store and sideload. See also Install and upgrade Smart ID Desktop App.
See also the prerequisites below regarding what version of Smart ID Desktop App is required.
Download the tool
The tool is distributed as self contained binary (no install required). You can download the file, MetadataTool.exe, from Nexus Support portal.
Run the tool via command line
These are the options for MetadataTool.exe:
Gather information about Smart ID Desktop App settings for backup and debug purposes
To gather information about the Smart ID Desktop App settings, use one of these methods:
Print the Smart ID Desktop App settings to the console
Export the Smart ID Desktop App settings into a file
Data is organized into these groups.
Modify or restore Smart ID Desktop App settings
You can import a file with settings to change the configuration of Smart ID Desktop App.
These are the structural options for the json file.
Individual parameter specifications -- Appdata
Should not be modified
Individual parameter specifications -- Settings
* This parameter cannot be modified directly in the app (only through the Metadata tool).
Individual parameter specifications -- Profiles
ProfileIdsList: string of profile ids separated by space.
Individual parameter specifications -- Secured parameters
Secured parameters provide functionalities bearing security risks. They are cryptographycally protected and cannot be modified by a regular user. They can only be temporarily enabled with assistance of the the Nexus personnel who has access to Azure KeyVault "kv-keyvault-common-37226". Their purpose is to help during an integration or debugging process.
Individual profile parameter specifications
When there is no specification for a given parameter then the acceptable values are arbitrary strings.
Migrate metadata between sideload and store version of Smart ID Desktop App
Metadata tool allows you to migrate metadata between the two versions in a simple way.
Merge profiles of both store and sideload app versions
You can export settings from the sideload app version into to store app version and vice versa. This example shows how to export settings from sideload to store.
This article is valid for Smart ID Desktop App 1.4.0 and later.