Audience & purpose

As a Product Administrator you want to check if you installed a license from you local machine or from the network drive.

• This tells you from where the license file was installed (local machine vs network drive).
• It allows you to give a better description of error messages when the action was unsuccessful.

Install license action

Use the following guidelines to review the install license action.

1. In the Audit log page, an Audit entry will be logged when a license file is installed in Product:

   Audit log entry

   Status	Time	Action	Item name	Action taken by	Device	Source
   Successful/Unsuccessful	<datetime>	Install license	<license file name>	<user a>	<hostname>	Product

2. If an error occurs while installing the license, then the status of Audit entry will be set to "Unsuccessful".
3. Select an Audit entry and click View action.
   • The "Details" page of the Audit entry will be displayed as shown in the following screenshot.

     

4. For the "Install license" action, the Details page will show whether the action was successful or unsuccessful.
   • If the Install action was unsuccessful it will display the exact error message in the Results frame as shown in the following screenshot.

     

5. The Audit log details page will be Read-Only. A user can only act on the page-level toolbar.
6. A breadcrumb trail will show Audit log → View action.
7. Click the Back button to return to the previous page.

Security

Note the following security items.

1. Only authorized users will be allowed to view ALL the Audit entries and their details.
2. A user having the "View and manage licenses" permission can view Audit entries for the "Install license" action.

Return to top

Audience & purpose

As a Product Admin you want to install and view RobotFarm multi-tenant license details so that you can monitor the license usage and availability for each of the AWS and VMware cloud providers used to deploy RobotFarm and run the automation task.

• This will help you to monitor RobotFarm license usage and availability.

Sample RobotFarm License Options

The following data table depicts several options for purchasing a RobotFarm license.

Option	Cloud Provider	Block Of Hrs	Robot runner	IQRobot	Valid
1	AWS	10,000	500	50	Yes
2	AWS	10,000	500	0	Yes
3	VMware	40,000	1000	50	Yes
4	VMware	10,000	500	0	Yes
5	Roboth: AWS & VMware	10,000, 5000	500, 1000	0, 25	Yes
6	Roboth: AWS & VMware	10,000, 5000	500, 1000	50, 0	Yes
7	Roboth: AWS & VMware	10,000, 5000	500, 1000	10, 25	Yes

Install and view RobotFarm license details

Step-by-Step

1. Login to Product as an Admin user.
2. Go to the Administration → Licenses page.
3. Click the "Install License" button to install a RobotFarm license having one or both cloud providers (AWS, VMware).
   1. The license file will be installed successfully with a success toast message.
4. The Robot user license table on the "License" landing page will display the purchase and usage details as shown in the following screenshot.

   

   1. The RobotFarm entries for either AWS or WMware or both will be displayed based on the purchased license.
   2. The entries will display the number of hours purchased for the respective cloud providers.
   3. It will display the number of Robot runners purchased including the number of IQRobots, if purchased.
   4. These Robot runner statistics will be maintained separately from the Robot runners purchased for Product.

Validation

Ensure that the purchased and used count for the respective RobotFarm on AWS, or WMware, or both, and its Robot runners (including IQRobots) will be updated correctly.

• The "Hours Used" count will be updated based on the automation execution time consumed by the Robot runners of the respective cloud providers.
• The "RobotrRunners Used" count will be updated whenever a Robot runner license is allocated or deallocated to/from the RobotFarm Agent user.
  1. If an IQ Robots license is allocated, then the "Used" count of Robot runners with IQRobots will be updated.
• The "Used" column value in the Product type table will be set to "Yes" when the Robot runner license "Used" count in the "Robot user" license table is set to non-zero.
• On reinstalling a new license with or without a RobotFarm license, the details will accordingly be updated.

Return to top

Audience & purpose

As a Product Admin you want to check the Analytics license at different places within the product. This will ensure that users are accessing product features with a valid license.

Procedure

Check the Analytics license when:

1. A Robot creator logs-in to Product.
2. The Robot creator clicks Analyze in the Task Editor or the Analytics flag in Task properties.
3. The Service APIs are called for data logging.
4. A user logs-in to the Analytics platform in their browser.

Return to top

Audience & purpose

As a Product Admin, when you install Product for the first time, you want Product to provide a trial license of 30 days so that you can evaluate Product. If you are satisfied then you can purchase and install a new Product license. This allows:

• The evaluation of Product for a limited period.
• The installation a new license during the trial period.

Trial License page: Continue trial

Scenario: Product is installed with a default trial license of 30 days.

1. Login to Product as a Product Admin.
2. If the trial license is not expired, then upon login the Product Admin will see a "Dashboard" → "Home" page with a ticker message. See the following data table:

   Ticker message

   Why?	Type	Title	Text (for both trial and purchased license)	Commands
   License will expire in less than or equal to 30 days.	Warning (in blue)	The Product license will expire in X days.	At that time, users will no longer be able to log on. Install a new license under Administration → Licenses. If you do not have a license, please contact your system administrator or Product Sales.	Hide details, Close
   The ticker message will display the days count as 30 for a new trial license.

Trial license statistics

Go to the "Administration" → "Licenses" page.

1. The License page will show the "Product License" statistics and the "Device License" statistics as shown in the following screenshot.

   

2. Note: As in the Product 10 LTS version, the default trial supports 3 Robot creators and 2 Robot runners.

Install an extended trial

If you install an extended trial (before trial expiry) then the trial period and license counts will be reset as per the extended trial license.

Validations

The days remaining will be updated with respect to the actual days left in the trial period.

• The trial license allows Product to run for 30 days with 3 Robot creators and 2 Robot runners.

Security

Product will run in trial mode as per the trial license that ships with the installer, or if the trial license is renewed and installed via the "Install License" page.

1. It will not be possible to manually tamper the trial period or license counts for Robot creator or Robot runners.

Return to top

Audience & purpose

As a Product user having the "License" permission, you want to:

• Know the total number of days remaining for your license to expire.
• Plan in advance for the renewal or purchase of a new license.
• Avoid losing access to Product when the existing license expires.

Display days remaining for license expiry

Scenario: Your Product license has days pending before it expires.

1. On login to Product, if the current installed license is yet to expire, then a ticker message will be displayed just below the browser URL.
   • This will show the total number of days remaining for the current, installed license to expire. See the following screenshot.

     

   System-level message

   Why?	Type	Title	Text (for both trial and purchased license)	Commands
   License will expire in less than or equal to 30 days.	Warning (in blue)	The Product license will expire in X days.	On <date>, users will no longer be able to log on. Install a new license under Administration → Licenses. If you do not have a license, please contact your system administrator or Product Sales.	Hide details, Close
   Example: <date> → September 15, 2017

2. Click "Hide details" to close the Details message for the current session.
   1. It will reappear the next time the user logs-in to Product.
   2. The "Hide details" link will change to "Show details".
3. Click "Show details" to make the message details appear again.
4. Click "Close" to hide the ticker message for that user session.
5. Click "Install new license" to display the License landing page.

Validation

If the number of remaining days is less than or equal to 30 days, then the ticker message will be displayed.

• It will be displayed only to a Product Admin or to a user having the "View and manage license" permission.
• On page refresh, the message will be displayed irrespective of the "Hide details" status.
• On opening this page in multiple browsers, the message "Hide details" status will be specific to the browser.

Refreshing the count of remaining days

The count "X" as described in the preceding data table message will be updated:

• With reference to the current date and the license expiry date.
• As and when another license file with a different expiry date is installed.

Return to top

Audience & purpose

As a Product Admin, you want to install a renewed Product license which is downgraded in terms of a license purchased this year as compared to a previous year. You want save on your license cost and provide a better ROI to the company.

Scenario:

• The current installed Product license is about to expire.
• The customer has purchased a new license which is downgraded in terms of license count or product types as compared to the current installed license.

Installing a downgrade license

Use the following guidelines to install a downgrade license.

1. In the Administration → Licenses page, click Install license.
2. Browse and select a new "downgrade" license file.
   • Note: When installing a new downgrade license, ensure that the purchase count of each license type meets the requirement of the currently allocated licenses.
   • If the requirement is met then the new downgrade license will be installed.
   • Upon installation, the license statistics will be updated with regards to the current license.
3. Otherwise,an appropriate error message will be displayed to the user as shown in the following screenshot.

   

4. See the following data tables for different types of downgrade scenarios.

RobotFarm downgrade scenarios

License type	Previous license	New license	Error condition
RobotFarm (Runtime)	Yes	No	If users with RobotFarm specific roles exist in Product.
RobotFarm (Runtime)	Purchased 100 hours and 60 hours were used.	Purchased an additional 50 hours.	None

Robot Insight downgrade scenarios

License type	Previous license	New license	Error condition
Robot Insight: Operational	Yes	Free	None
Robot Insight: Business	Yes	No	If users with Robot Insight specific roles exist in Product.
Robot Insight: Business	Yes	Yes	If users having a Robot Insight license allocated from a previous license is more than the newly purchased license.

Devices downgrade scenarios

License type	Previous license	New license	Error condition
Robot creator	Yes	No	Not possible
Robot creator	Purchased 50 Robot creators and 30 are in use.	Purchased only 20 Robot creators.	If the number of Robot creators purchased are less than compared to the allocated licenses.
Robot runner: TaskRobots	Yes	No	Not possible
Robot runner: TaskRobots	Purchased 50 Robot runners and 30 are in use.	Purchased only 20 Robot runners.	If the number of Robot runners purchased are less than compared to the allocated license.
Robot runner: MetaRobots	Yes	Free	None
Robot runner: MetaRobots	Purchased 50 Robot runners, 30 are in use out of which 10 Robot runners have a MetaRobot license.	Purchased 20 Robot runners with TaskRobots + MetaRobots.	If the number of purchased MetaRobot licenses is less than compared to an allocated license.
Robot runner: IQRobots	Yes	No	If a user with an IQRobots license exists in Product.
Robot runner: IQRobots	Purchased 50 Robot runners, 30 are in use out of which 10 Robot runners have IQRobot licenses.	Purchased 20 Robot runners with 5 IQRobots licenses.	The number of allocated licenses is more than the number of purchased licenses.

Error message

The following error message will be displayed for a downgrade scenario.

Type	Reason	Message
Critical	The current license does not cover a number of functions that are currently in use.	The Product license you are trying to install does not have the following permissions: Sufficient Robot Creator device licenses: The new license allows for 50 Robot Creators, but you currently have 60 Robot Creator licenses in use. Sufficient Robot Runner device licenses: The new license allows for 500 Robot Runners, but you currently have 1,000 Robot Runner licenses in use. Sufficient Robot Runner with IQ Robots device licenses: The new license allows for 30 Robot Runners with IQ Robots, but you currently have 72 Robot Runner licenses with IQ Robots in use. The new license does not allow any IQ Robots. You currently have 50 Robot Runners with IQ Robots. RobotFarm: Currently, 4 users have a role that requires the RobotFarm license. Robot Insight: Currently, 10 users have a role that requires the Robot Insight license. To continue, you will need to remove the items that are not covered by the new license. If your old license has expired, please contact Product Sales to get a temporary license in order to make these changes.
Note: The error message will only list those bullet points that are relevant with the error conditions.

Return to top

Audience & purpose

As a Product user having the "License" permission, you want to install a new Product license to continue using Product. It will allow you to:

• Comply with using a licensed copy of Product.
• Use Product and leverage the various features and functionalities it offers.
• Have an extended trial license or switch to a purchased license.
• Allow the distribution of license seats across Product users.

Prerequisites

Make sure the following required items are in place before installing the new license.

1. Product is already installed.
2. Product Admin is already created.
3. Product is up and running on a valid (not expired) trial license.

Install License

Use the following guidelines to perform a new Product license installation.

1. Login as a Product Admin.
2. Go to the Administration → Licenses page which is shown in the following screenshot.

   

3. Click the Install license link.
   • The Install license page will be displayed as shown in the following screenshot.

     

   • The Install license button will be disabled by default until a new license is selected.
4. Click Browse.
   • A "File browse" dialog box will open displaying the .license files by default.
   • Browse to the location and select the .license file in the "File browse" dialog.
5. Click Open.
   • The "File browse" dialog box will close and the selected file will be displayed as shown in the following screenshot.

     

6. Click "Install license".
   • The license file will immediately start installing. See the following screenshot.

     

7. Once the license file is successfully installed, the Install License page will close.
   • A toast notification will be displayed on the license landing page. See the following screenshot.

     

Validations

The Install license button will be disabled by default until a new license file is selected.

1. If an error occurs on file selection, then the "Install License" button will be disabled.
   • On subsequent file selection, if the file is valid, the error message will be cleared and the "Install License" button will be enabled.
2. Click "Cancel" in the File Browse dialog box to clear the selected file path (if any) and the error message (displayed from previous selection) if any, will also be cleared.
3. The following error messages will be displayed if an error condition arises. See the following screenshot and data table after it.

   

4. The error message data table:

   Condition	Message
   Different file extension	Unable to continue because the file you selected does not end with ".license". To continue, please select an Product license file which ends with ".license".
   Expired or invalid license file	Unable to continue because the file you selected is either invalid or its license period has expired. To continue, please install a new Product license. If you do not have one, please contact your system administrator or Product Sales.

5. Once a license file is successfully installed, it will NOT ask the Product Admin to re-login.
6. It will allow the installation of any type of license file, for example "Trial" or "Purchase".
7. Post installation, if the license days remaining are < = 30, then the ticker message will be displayed.
   • If the user does not close the ticker message but instead clicks the "Install new license" link, this action installs a new license.
   • If the license has < = 30 days, then the ticker message will close.
   • If it is < = 30, then the ticker message will remain open with the days count updated as per the new license.

Return to top

Audience & purpose

As an Product License Admin, you want to make changes to the License portal by adding or removing some of the license flags.

• This will enable you to generate a license as per the Product version 11.0 business requirement.
• The changes from Product version 10.x to 11.0 include:
  • The merging of MetaRobots with TaskRobots.
  • Operational analytics being provided by default.
  • An Analytics API being introduced.

Robot Insight license changes

In Product 11.0, Operational analytics will be provided by default.

1. Accordingly, the flag "APPS_ANALYTICS_OPERATIONAL" is removed from the License portal.
2. We introduce a new field to set the number of Business Analytics users.
   • This field will only be enabled if the Business Analytics flag is set to "true".
   • The default value of this field will be 10 (sold in a pack of 10).
3. We introduce a new flag APPS_ANALYTICS_API to enable the Analytics API. See the following screenshot.
4. Accordingly, we introduce a new field to set the number of records the Analytics API is allowed to fetch from the database.
   • This field is enabled only if the API flag is set to true.
   • The default value of this field is 1 million (1,000,000) records.
5. The other flags for the Robot Insight app will not be changed. For example:
   • ANALYTICS = Default "FALSE"
   • APPS_ANALYTICS_BUSINESS = Default "FALSE"

     

Merging MetaRobots to TaskRobots

In the Product 11.0 release, the MetaRobots will be merged with TaskRobots.

• Correspondingly, the flag to enable MetaRobots will be removed from the License portal.
• Also the field to set the number of MetaRobots will be removed. See the following screenshot.

  

• Note: For Product 11.0, a new license key will be generated.

Return to top

Audience & purpose

As a Product Admin:

• You want to restrict access to Product if the current installed Product license has expired so that you abide by the license terms to use Product.
• You also want an option to install a new license if the Product license has expired so that you can continue using Product.

License expired message

Use the following guidelines regarding an expired Product license.

1. Login to Product as a Product Admin.
2. If the current installed license has expired then a "license expired" error message will be displayed as shown in the following screenshot.

   

   Type	Reason	Message
   Critical	Product license has expired.	The Product license has expired. To continue, please install a new license. If you do not have one, please contact your system administrator or Product Sales.

3. The Product Admin will not be allowed to see the "Dashboard" → "Home" page until he installs a new Product license.
4. If any other user logs-in to Product via a browser, the following error message will be displayed. See the following screenshot.

   

   Type	Reason	Message
   Error	Product license has expired	Product license is expired. To continue, please contact your system administrator.

New user first login: License expired

If a Non-AD user logs-in to Product for the first time, and if the license is already expired, then the user will first get the license expired message.

Once the license is installed and if the first login of the Product user is successful, then the user will be:

• Allowed to change the password.
• Set the security questions.

Install a new license

On the "Install License" page, the "Install License" button will be disabled until the Admin selects the license file.

1. Click "Browse" and select a ".license" file.
   • The license file path will be displayed and the "Install License" button will be enabled.
2. Click "Install License". See the following screenshot.

   

3. If the license is successfully installed then the "Dashboard" → "Home" page will open and display a success toast message and displayed as shown in the following screenshots.

   

4. For further reference, see the "Install a new license in Product" topic located in this page.

Return to top

Audience & purpose

As a Product user having the "License" permission, you want to view details of the current installed license so that you can analyze license statistics and manage its usage across different users. This will help you to:

• Know license statistics and usage for Product and all other apps registered with Product.
• Plan for renewal or purchase of a new license.

Product license details

The "Administration" → "Licenses" page will display statistics of the current license installed in Product as shown in the following screenshot.

1. The "Used" status for the Robot Insight - Business Analytics is based on whether or not a user has the "Robot Insight Consumer" role.
2. The "Last updated" will be set to the date when the new license was successfully installed.
3. The "License Type" will be set to "Purchased" if it is a purchased license, otherwise "Trial" if it is a trial license.
4. The "Expires on" will be set to the date when the current installed license will expire.
5. The "Product license" table will display values as per the installed license. See the following data table.

   Column	Values
   Type (with status icon)	Product, Cognitive Platform, RobotFarm, Robot Insight, Business Analytics, API.
   Version	The version number of Product, Cognitive Platform, RobotFarm, and Robot Insight.
   Purchased	Purchased, Not purchased
   Used	Used, Not used, N/A
   Note: ▸ If Purchased = Not purchased, then "Used" is set to N/A. ▸ For a trial license, Purchased = Trial.

Robot user license details

The Robot user license table will display the count of user licenses, Robot user-wise. See the following data table.

Column	Values
Type	RobotFarm (Runtime), Robot Insight, Business Analytics, API, Robot runner (Run-time with Task Robots, includes IQ Robots).
Purchased	The number of user licenses purchased.
Used	The number of Robot users consuming a license.
Note: ▸ For "RobotFarm", the count is measured in the number of hours the RobotFarm Runtime uses to execute a Robot. ▸ For "Robot Insight", the API count is measured in the number of rows the API fetches from the database.

Validations

Note:

• The tables will reflect the correct license and usage details.
• The tables will be updated if a different license is installed.

Return to top