robot
2021.10
false
- Release Notes
- Getting Started
- UiPath Assistant
- Installation and Upgrade
- Robot Types
- Robot Components
- Licensing
- Licensing a Robot
- LicenseTool Command Descriptions
- Connecting Robots to Orchestrator
- Processes and Activities
- Logging
- Robot JavaScript SDK
- Specific Scenarios
- Windows Sessions
- Login Using Thales Luna Credential System
- Login Using NShield Key Storage Provider
- Redirecting Robots Through a Proxy Server
- Executing Tasks in a Minimized RDP Window
- Using Mapped Network Drives
- Stopping a Process
- Disable Stop Button
- Custom Package Folders and Network Paths
- CrowdStrike Integration
- Troubleshooting
- Unresponsive Robot Over RDP
- Duplicate Execution Logs
- Frequently Encountered Robot Errors
- Increased Process Execution Duration
- Enforced Package Signature Verification
- Message Too Large to Process
- Errors When Running as Administrator
- NuGet Packages Not Accessible After Migration
- User Access Control Prompt and UI Automation Activities
- .NET6 Projects Fail to Run
Robot User Guide
Last updated Oct 25, 2024
LicenseTool Command Descriptions
The
UiPath.LicenseTool.exe is a command line utility which enables you to activate your machine online or offline, and update your license information.
The utility can be found in the C:\Program Files\UiPath\Studio folder by default.
Please note that this tool is only used to activate your license locally. If you choose to activate your license with this tool, it is important to specify that you use a Standalone license when you create a Robot in Orchestrator for that particular machine.
All the examples displayed on this page are constructed from the assumption that you first navigated to the location of the
UiPath.LicenseTool.exe utility, by using the cd command (cd C:\Program Files\UiPath\Studio).
The following commands require an active internet connection in order to process your request.
The
activate command is used to activate a license online via an existing license code. The following parameters are supported:
|
Parameter |
Description |
Priority |
|---|---|---|
-l, --LicenseCode |
The license code required for activation. |
Mandatory |
-u, --ProxyUrl |
The URL used for the proxy connection (such as http://your.proxy.server.com). |
Optional |
-p, --ProxyPort |
The Port number of the proxy connection. |
Optional. Mandatory if the
-u parameter is used.
|
-s, --ProxyUser |
The username associated with your proxy connection. |
Optional. Mandatory if the
-u parameter is used.
|
-w, --ProxyPassword |
The password for the user associated with your proxy connection. |
Optional. Mandatory if the
-u parameter is used.
|
C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe activate -l 1234-2303-2194-5598
License registration state: ActiveLicense
License successfully activated!C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe activate -l 1234-2303-2194-5598
License registration state: ActiveLicense
License successfully activated!Online activation can also be done from Studio.
The
update command is used update an existing license online. The following parameters are supported:
|
Parameter |
Description |
Priority |
|---|---|---|
-u, --ProxyUrl |
The URL used for the proxy connection (such as http://your.proxy.server.com). |
Optional |
-p, --ProxyPort |
The Port number of the proxy connection. |
Optional. Mandatory if the
-u parameter is used.
|
-s, --ProxyUser |
The username associated with your proxy connection. |
Optional. Mandatory if the
-u parameter is used.
|
-w, --ProxyPassword |
The password for the user associated with your proxy connection. |
Optional. Mandatory if the
-u parameter is used.
|
C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe update
License registration state: ActiveLicense
License successfully updated!C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe update
License registration state: ActiveLicense
License successfully updated!The
deactivate command is used to deactivate a local license. This way, the license becomes available for activation on a different computer.
The following parameters are supported:
|
Parameter |
Description |
Priority |
|---|---|---|
-u, --ProxyUrl |
The URL used for the proxy connection (such as http://your.proxy.server.com). |
Optional |
-p, --ProxyPort |
The Port number of the proxy connection. |
Optional. Mandatory if the
-u parameter is used.
|
-s, --ProxyUser |
The username associated with your proxy connection. |
Optional. Mandatory if the
-u parameter is used.
|
-w, --ProxyPassword |
The password for the user associated with your proxy connection. |
Optional. Mandatory if the
-u parameter is used.
|
C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe deactivate
License registration state: NoLicenseAvailable
License successfully deactivated!C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe deactivate
License registration state: NoLicenseAvailable
License successfully deactivated!The
activation-request command is used to generate an activation token from your license code. The generated token needs to be used on the Activation Portal to generate the corresponding license file. The following parameters are supported:
|
Parameter |
Description |
Priority |
|---|---|---|
-l, --LicenseCode |
The license code required for activation. |
Mandatory |
o, --FileName |
Writes the license information to file. If this parameter is not specified, the license information is displayed in the command prompt window. |
Optional |
C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe activation-request -l 1234-2303-2194-5598
Activation Token: eyJsaWNlbnNlQ29kZSI6Ijk1NTUtMjMwMy0yMTk0LTU11234WFpbCI6InNvbWUuZW1haWxAZXhhbXBsZS5vcmciLCJtZXRhZGF0YSI6eyJyYW0iOiIzNDE0NjA0MTg1NiIsImRpc3BsYXlOYW1lIjoiSW50ZWwoUikgVUhEIEdyYXBoaWNzIDYzMCIsInZlcnNpb24iOiIxOS43LjAiLCJzeXN0ZW1MYW5nIjoiMDQwOSIsInN5c3RlbU1vZGVsIjoiT3B0aVBsZXggNTA2MCIsIm9zTmFtZSI6IlBDLURPRE9JVUIiLCJ1c2VyTmFtZSI6ImJvZ2Rhbi5kb2RvaXUiLCJzeXN0ZW1OYW1lIjoiUEMtRE9ET0lVQiIsImRpc3BsYXlSZXMiOiIxMDI0IGJ5IDc2OCBwaXhlbHMsIFRydWUgQ29sb3IsIDYwIEhlcnR6IiwicHJvY2Vzc29yIjoiSW50ZWwoUikgQ29yZShUTSkgaTctODcwMCBDUFUgQCAzLjIwR0h6Iiwic3lzdGVtVHlwZSI6Ing2NC1iYXNlZCBQQyJ9LCJsaWNlbnNpbmdNb2RlbERhdGEiOnsidXNlcklkIjoiYm9nZGFuLmRvZG9pdSIsIm1hY2hpbmVJZCI6IlBDLURPRE9JVUIifX0=
Go to https://activate.uipath.com and paste the activation token in the dialogue box to generate the license file for offline activation.C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe activation-request -l 1234-2303-2194-5598
Activation Token: eyJsaWNlbnNlQ29kZSI6Ijk1NTUtMjMwMy0yMTk0LTU11234WFpbCI6InNvbWUuZW1haWxAZXhhbXBsZS5vcmciLCJtZXRhZGF0YSI6eyJyYW0iOiIzNDE0NjA0MTg1NiIsImRpc3BsYXlOYW1lIjoiSW50ZWwoUikgVUhEIEdyYXBoaWNzIDYzMCIsInZlcnNpb24iOiIxOS43LjAiLCJzeXN0ZW1MYW5nIjoiMDQwOSIsInN5c3RlbU1vZGVsIjoiT3B0aVBsZXggNTA2MCIsIm9zTmFtZSI6IlBDLURPRE9JVUIiLCJ1c2VyTmFtZSI6ImJvZ2Rhbi5kb2RvaXUiLCJzeXN0ZW1OYW1lIjoiUEMtRE9ET0lVQiIsImRpc3BsYXlSZXMiOiIxMDI0IGJ5IDc2OCBwaXhlbHMsIFRydWUgQ29sb3IsIDYwIEhlcnR6IiwicHJvY2Vzc29yIjoiSW50ZWwoUikgQ29yZShUTSkgaTctODcwMCBDUFUgQCAzLjIwR0h6Iiwic3lzdGVtVHlwZSI6Ing2NC1iYXNlZCBQQyJ9LCJsaWNlbnNpbmdNb2RlbERhdGEiOnsidXNlcklkIjoiYm9nZGFuLmRvZG9pdSIsIm1hY2hpbmVJZCI6IlBDLURPRE9JVUIifX0=
Go to https://activate.uipath.com and paste the activation token in the dialogue box to generate the license file for offline activation.The
activate-offline command is used to activate a license offline. It uses the license file generated by the Activation Portal from the provided activation token generated by the activation-request command. The following parameters are supported:
|
Parameter |
Description |
Priority |
|---|---|---|
-f, --LicenseFile |
The path to the license file obtained from the activation portal. |
Mandatory
1 |
-i, --LicenseContent |
The content of the license file received after using the
Activation-Request operation.
|
Mandatory
1 |
-
1- You can only use either the-for-iparameters with theactivate-offlineoperation. They are not both supported at the same time.C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe activate-offline -f c:\Downloads\license.txt License registration state: ActiveLicense License successfully activated!C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe activate-offline -f c:\Downloads\license.txt License registration state: ActiveLicense License successfully activated!
Offline activation can also be done from Studio.
The
update-request command is used to generate an update token for your license. The update token needs to be used on the Activation Portal to generate the corresponding license file. The following parameters are supported:
|
Parameter |
Description |
Priority |
|---|---|---|
-o, --FileName |
Writes the license information to file. If this parameter is not specified, the license information is displayed in the command prompt window. |
Optional |
C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe update-request
Update Token: eyJsaWNlbnNlQ29kZSI6Ijk1NTUtMjMwMy0yMTk0LTU112345lbWFpbCI6bnVsbCwibWV0YWRhdGEiOnsicHJvY2Vzc29yIjoiSW50ZWwoUikgQ29yZShUTSkgaTctODcwMCBDUFUgQCAzLjIwR0h6Iiwic3lzdGVtTW9kZWwiOiJPcHRpUGxleCA1MDYwIiwidXNlck5hbWUiOiJib2dkYW4uZG9kb2l1IiwiZGlzcGxheVJlcyI6IjEwMjQgYnkgNzY4IHBpeGVscywgVHJ1ZSBDb2xvciwgNjAgSGVydHoiLCJ2ZXJzaW9uIjoiMTkuNy4wIiwicmFtIjoiMzQxNDYwNDE4NTYiLCJzeXN0ZW1MYW5nIjoiMDQwOSIsIm9zTmFtZSI6IlBDLURPRE9JVUIiLCJkaXNwbGF5TmFtZSI6IkludGVsKFIpIFVIRCBHcmFwaGljcyA2MzAiLCJzeXN0ZW1UeXBlIjoieDY0LWJhc2VkIFBDIiwic3lzdGVtTmFtZSI6IlBDLURPRE9JVUIifSwibGljZW5zaW5nTW9kZWxEYXRhIjp7InVzZXJJZCI6ImJvZ2Rhbi5kb2RvaXUiLCJtYWNoaW5lSWQiOiJQQy1ET0RPSVVCIn19
Go to https://activate.uipath.com and paste the update token in the dialogue box to generate the license file for offline update.C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe update-request
Update Token: eyJsaWNlbnNlQ29kZSI6Ijk1NTUtMjMwMy0yMTk0LTU112345lbWFpbCI6bnVsbCwibWV0YWRhdGEiOnsicHJvY2Vzc29yIjoiSW50ZWwoUikgQ29yZShUTSkgaTctODcwMCBDUFUgQCAzLjIwR0h6Iiwic3lzdGVtTW9kZWwiOiJPcHRpUGxleCA1MDYwIiwidXNlck5hbWUiOiJib2dkYW4uZG9kb2l1IiwiZGlzcGxheVJlcyI6IjEwMjQgYnkgNzY4IHBpeGVscywgVHJ1ZSBDb2xvciwgNjAgSGVydHoiLCJ2ZXJzaW9uIjoiMTkuNy4wIiwicmFtIjoiMzQxNDYwNDE4NTYiLCJzeXN0ZW1MYW5nIjoiMDQwOSIsIm9zTmFtZSI6IlBDLURPRE9JVUIiLCJkaXNwbGF5TmFtZSI6IkludGVsKFIpIFVIRCBHcmFwaGljcyA2MzAiLCJzeXN0ZW1UeXBlIjoieDY0LWJhc2VkIFBDIiwic3lzdGVtTmFtZSI6IlBDLURPRE9JVUIifSwibGljZW5zaW5nTW9kZWxEYXRhIjp7InVzZXJJZCI6ImJvZ2Rhbi5kb2RvaXUiLCJtYWNoaW5lSWQiOiJQQy1ET0RPSVVCIn19
Go to https://activate.uipath.com and paste the update token in the dialogue box to generate the license file for offline update.The
update-offline command is used to update a license offline. It uses the generated file by the Activation Portal from the provided update token generated by the update-request command. The following parameters are supported:
|
Parameter |
Description |
Priority |
|---|---|---|
-f, --LicenseFile |
The path to the license file obtained from the activation portal. |
Mandatory
1 |
-i, --LicenseContent |
The content of the license file received after using the
Update-Request operation.
|
Mandatory
1 |
-
1- You can only use either the-for-iparameters with theupdate-offlineoperation. They are not both supported at the same time.C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe update-offline -f c:\Downloads\license-update.txt License registration state: ActiveLicense License successfully updated!C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe update-offline -f c:\Downloads\license-update.txt License registration state: ActiveLicense License successfully updated!
The
deactivation-request command is used to deactivate a local license offline and generate a deactivation token. The license is immediately deactivated
on the local computer and another one can be activated if needed. The generated deactivation token needs to be used on the
Activation Portal to deactivate the license. Please note that the license which was deactivated offline with this command
can not be reused until it is released. The following parameters are supported:
|
Parameter |
Description |
Priority |
|---|---|---|
-o, --FileName |
Writes the license information to file. If this parameter is not specified, the license information is displayed in the command prompt window. |
Optional |
C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe deactivation-request
Deactivation Token: eyJsaWNlbnNlQ29kZSI6Ijk1NTUtMjMwMy0yMTk0LT1234giLCJsaWNlbnNpbmdNb2RlbERhdGEiOnsidXNlcklkIjoiYm9nZGFuLmRvZG9pdSIsIm1hY2hpbmVJZCI6IlBDLURPRE9JVUIifSwibWV0YWRhdGEiOnsib3NOYW1lIjoiUEMtRE9ET0lVQiIsInVzZXJOYW1lIjoiYm9nZGFuLmRvZG9pdSIsInZlcnNpb24iOiIxOS43LjAiLCJkaXNwbGF5UmVzIjoiMTAyNCBieSA3NjggcGl4ZWxzLCBUcnVlIENvbG9yLCA2MCBIZXJ0eiIsInN5c3RlbU5hbWUiOiJQQy1ET0RPSVVCIiwicHJvY2Vzc29yIjoiSW50ZWwoUikgQ29yZShUTSkgaTctODcwMCBDUFUgQCAzLjIwR0h6Iiwic3lzdGVtVHlwZSI6Ing2NC1iYXNlZCBQQyIsInJhbSI6IjM0MTQ2MDQxODU2IiwiZGlzcGxheU5hbWUiOiJJbnRlbChSKSBVSEQgR3JhcGhpY3MgNjMwIiwic3lzdGVtTGFuZyI6IjA0MDkiLCJzeXN0ZW1Nb2RlbCI6Ik9wdGlQbGV4IDUwNjAifX0=
License successfully deactivated locally!
To release the license on the sever side and use it on another machine, go to https://activate.uipath.com and paste the deactivation request certificate as text in the <code>Deactivate your licence</code> tab.C:\Program Files\UiPath\Studio\UiPath.LicenseTool.exe deactivation-request
Deactivation Token: eyJsaWNlbnNlQ29kZSI6Ijk1NTUtMjMwMy0yMTk0LT1234giLCJsaWNlbnNpbmdNb2RlbERhdGEiOnsidXNlcklkIjoiYm9nZGFuLmRvZG9pdSIsIm1hY2hpbmVJZCI6IlBDLURPRE9JVUIifSwibWV0YWRhdGEiOnsib3NOYW1lIjoiUEMtRE9ET0lVQiIsInVzZXJOYW1lIjoiYm9nZGFuLmRvZG9pdSIsInZlcnNpb24iOiIxOS43LjAiLCJkaXNwbGF5UmVzIjoiMTAyNCBieSA3NjggcGl4ZWxzLCBUcnVlIENvbG9yLCA2MCBIZXJ0eiIsInN5c3RlbU5hbWUiOiJQQy1ET0RPSVVCIiwicHJvY2Vzc29yIjoiSW50ZWwoUikgQ29yZShUTSkgaTctODcwMCBDUFUgQCAzLjIwR0h6Iiwic3lzdGVtVHlwZSI6Ing2NC1iYXNlZCBQQyIsInJhbSI6IjM0MTQ2MDQxODU2IiwiZGlzcGxheU5hbWUiOiJJbnRlbChSKSBVSEQgR3JhcGhpY3MgNjMwIiwic3lzdGVtTGFuZyI6IjA0MDkiLCJzeXN0ZW1Nb2RlbCI6Ik9wdGlQbGV4IDUwNjAifX0=
License successfully deactivated locally!
To release the license on the sever side and use it on another machine, go to https://activate.uipath.com and paste the deactivation request certificate as text in the <code>Deactivate your licence</code> tab.The
UiPath.LicenseTool.exe utility also contains a few generic commands. They provide information about your license, and can help you get accustomed
to the supported commands and parameters.
|
Command |
Description |
|---|---|
|
|
Displays information about the license, such as:
|
|
|
Displays information about all the supported commands and parameters. |
|
|
Displays the version of the
UiPath.LicenseTool.exe utility.
|
