...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
This article describes the Smart ID Desktop App 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
...
| Warning |
|---|
Smart ID Desktop App metadata tool is only supported up to version 1.13.5. |
| Info |
|---|
| This article is updated for Smart ID Desktop App 1.12.1. |
This article describes the Smart ID Desktop App metadata tool. The tool is available for download from version 1.3.5 of Smart ID Desktop App.
| Excerpt |
|---|
| 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).
See also the prerequisites below regarding what version of Smart ID Desktop App is required.
...
| Expand | ||
|---|---|---|
| ||
The tool is distributed as self contained binary (no install required). You can download the file, MetadataTool.exe, from Nexus Support portal. |
...
| Expand | ||
|---|---|---|
| ||
|
...
|
...
...
| Expand | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
These are the options for MetadataTool.exe:
|
...
|
...
|
...
|
Gather information about Smart ID Desktop App settings for backup and debug purposes
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||
|---|---|---|
| ||
To gather information about the Smart ID Desktop App settings and profile metadata, use one of these methods: |
...
|
...
When both variants of Smart ID Desktop App are installed (store and sideload) specify the installtype parameter (-t), values can be store or sideload.
Example when Desktop App was downloaded from Microsoft store:
...
| title | Example: App downloaded from Microsoft Store |
|---|
...
Print the Smart ID Desktop App settings and profile metadata to the console 1. To print the Smart ID Desktop App settings and profile metadata to the console in json format, use the following command:
or
|
...
Export the Smart ID Desktop App settings and profile metadata into a file 2. To export the Smart ID Desktop App settings and profile metadata into a file (saved in the folder that includes the binary file), use the following command:
|
...
Example when Desktop App was downloaded from Nexus support portal and installed with sideloading enabled:
...
| title | Example: App installed with sideloading enabled |
|---|
...
or
|
...
Export the Smart ID Desktop App settings into a file
To export the Smart ID Desktop App settings into a file (saved in the folder that includes the binary file), use the following command:
...
|
...
...
|
| Code Block |
|---|
MetadataTool.exe --dump > output_file_name.json |
...
|
| Expand | ||
|---|---|---|
| ||
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.
| Expand | ||
|---|---|---|
| ||
|
| Expand | ||
|---|---|---|
| ||
These are the structural options for the json file.
|
...
| title | Example: Full json file |
|---|---|
| collapse | true |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
Or the json file can have a simplified structure (not using the groups):
...
| title | Example: Simplified json file |
|---|---|
| collapse | true |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
...
|
...
|
...
It is not necessary to specify all parameters:
...
| title | Example: Only specify some parameters in the json file |
|---|---|
| collapse | true |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
| Note |
|---|
It is NOT recommended to use the |
...
| title | Structure of the json file |
|---|
Individual parameter specifications -- Appdata
Should not be modified
Individual parameter specifications -- Settings
...
If the value is true, the app will show all profile certificates (a certificate is hidden if its keyid start with ".")
...
* 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
...
| title | Modify the secured parameters - can only be done by Nexus personnel |
|---|
...
User related data: PCName, DomainName, UserDomainName (at least one of the three needs to specified). See an example file here:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"Options": {
"SecureLogging": "true",
"UseHttp": "true"
},
"DaysToExpiration": "10",
"PCName": "DESKTOP-QE86VR1",
"DomainName":,
"UserDomainName": "DESKTOP-QE86VR1\\Tom"
} |
Sign the file using metadata tool (requires access to Azure KeyVault "kv-keyvault-common-37226"):
| Code Block |
|---|
MetadataTool.exe -s dataSample.json > SignedParams.json |
Import the parameters:
| Code Block |
|---|
MetadataTool.exe -i SignedParams.json |
To display the values of the 3 parameters (PCName, DomainName, UserDomainName) corresponding to a particular user/pc:
| Code Block |
|---|
MetadataTool.exe -g |
Individual profile parameter specifications
| Note |
|---|
Do NOT change profile data, as this may lead to unexpected behavior of Smart ID Desktop App. |
When there is no specification for a given parameter then the acceptable values are arbitrary strings.
...
| title | Import the json file |
|---|
To import a json file to Smart ID Desktop App, use the following command:
| Code Block |
|---|
MetadataTool.exe -i [import_json_path] |
or
| Code Block |
|---|
MetadataTool.exe --import [import_json_path] |
...
When both variants of Smart ID Desktop App are installed (store and sideload) specify the installtype parameter (-t), values store or sideload.
Example when Desktop App was downloaded from Microsoft Store:
| Code Block | ||
|---|---|---|
| ||
MetadataTool.exe -i [import_json_path] -t store |
Example when Desktop App was downloaded from Nexus support portal and installed with sideloading enabled:
| Code Block | ||
|---|---|---|
| ||
MetadataTool.exe -i [import_json_path] -t sideload |
To also clean the Smart ID Desktop App settings, when importing the json file, use the following command:
| Code Block |
|---|
MetadataTool.exe -i [import_json_path] -c |
or
| Code Block |
|---|
MetadataTool.exe --import [import_json_path] --clean |
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.
...
| title | Migrate metadata to store from sideload version |
|---|
To migrate metadata to store from sideload version:
| Code Block | ||
|---|---|---|
| ||
metadatatool.exe --migrateToStoreFromSideload |
or
| Code Block |
|---|
metadatatool.exe -m |
| Note |
|---|
All store version metadata will be lost (replaced by sideload version metadata). |
...
| title | Migrate metadata to sideload from store version |
|---|
To migrate metadata to sideload from store version:
| Code Block | ||
|---|---|---|
| ||
metadatatool.exe --MigrateToSideloadFromStore |
or
| Code Block |
|---|
metadatatool.exe -n |
| Note |
|---|
All sideload version metadata will be lost (replaced by store version metadata). |
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.
...
| title | Merge profiles |
|---|
...
Export settings from the sideload app version in a json file:
| Code Block | ||
|---|---|---|
| ||
metadatatool.exe -d -t sideload > out.json |
Import the settings into the store app version:
| Code Block | ||
|---|---|---|
| ||
metadatool.exe -i out.json -t store |
This article is valid for Smart ID Desktop App 1.4.0 and later.
Related information
...
|
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Individual parameter specifications -- AppdataShould not be modified Individual parameter specifications -- Settings
* This parameter cannot be modified directly in the app (only through the Metadata tool). Individual parameter specifications -- ProfilesProfileIdsList: string of profile ids separated by space. Individual parameter specifications -- Secured parametersSecured 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.
|
| Expand | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|