Listen | Translate
Apps registration
This section covers the user interface and registration of apps in Product.
App registration UI
- Audience & purpose
- As a Product Administrator you want to have an interface to register the Product app and use it to create app registration entries.
Procedure
Use the following guidelines to set up app registration in Product.
- If the Product license has a RobotFarm or Analytics flag on, then the left panel will display an "App registration" tab.
- In this tab, click "Register app" to create a registration entry and then save it.
- You can input an app name, description, app type, and URL.
- It will be possible to add, update, or delete registration entries.
Audit trail: App registration
- Audience & purpose
- As a Product Admin you want to have Audit Entries created for each app registered with Product for auditing purposes.
Note:
The Audit Trail will display respective Audit entries for a ProductUD (Create Read Update Delete) operation upon an app's registration.
RobotFarm: Generate RobotFarm license token
- Audience & purpose
-
As a Product Admin you want to:
- Generate a RobotFarm license token.
- Push it to RobotFarm when you install a Product license.
- Make RobotFarm usage available as per the number of Product licensing days.
Procedure
Use the following guidelines to generate a RobotFarm license token.
- Install the Product license.
- Register the RobotFarm App.
- The RobotFarm license token will be generated and pushed to RobotFarm.
- RobotFarm is accessible as long as the Product license is valid and not expired.
RobotFarm: Re-generate RobotFarm license token
- Audience & purpose
-
As a Product Admin you want to:
- Regenerate a RobotFarm license token and push it to RobotFarm when you re-install a Product license that has expired.
- Make RobotFarm usage available as per the number of Product licensing days.
Procedure
Use the following guidelines to regenerate a RobotFarm license token.
- Renew the Product license and install it in Product.
- If the RobotFarm App is already registered, the RobotFarm license token will be re-generated and pushed to RobotFarm.
- RobotFarm is now accessible upon the Product license renewal.
Robot Insight: Generate Robot Insight license token
- Audience & purpose
-
As a Product Admin you want to:
- Generate a Robot Insight license token.
- Push it to the Robot Insight platform when you install the Product license.
- Make Robot Insight usage available as per the number of Product licensing days.
Procedure
Use the following guidelines to generate a Robot Insight license token.
- Install the Product license.
- Register the Robot Insight App.
- The Robot Insight License Token will be generated and pushed to the Robot insight platform.
- Robot Insight will be accessible until the Product license has expired.
Robot Insight: Regenerate Robot Insight license token
- Audience & purpose
-
As a Product Admin you want to:
- Regenerate the Robot insight license token.
- Push it to the Robot insight platform when you re-install the Product license upon its expiration.
- Make Robot insight usage available as per the number of Product licensing days.
Procedure
Use the following guidelines to regenerate a Robot insight license token.
- Renew the Product license and install it in Product.
- If the Robot insight app is already registered, the Robot insight license token will be regenerated and pushed to the Robot insight platform.
- Robot insight is now accessible upon the license renewal in Product.
Identity tokens for an app registered with Product
- Audience & purpose
-
As a Product Admin you want to generate a unique identity token for each app registered with Product.
- This ensures that all communication between Product and the registered app takes place through this token.
Procedure
Once an app is registered with Product:
- A unique identity token will be generated to identify the registered app.
- This token will be used for each communication between Product and the registered app.
Register Robot Insight
- Audience & purpose
- As a Product Admin you want to register a Robot Insight app so that Product can send log data for analysis to the Analytics platform.
Procedure
As a prerequisite, Product and Robot Insight must be installed.
- The Product license should have the Robot Insight flag set to "ON".
- Create a registration entry with "app.type" as ANALYTICS and with the URL of the Robot Insight server.
- On Save, the Robot Insight app will be registered with Product upon verification.
Register RobotFarm
- Audience & purpose
- As a Product Admin you want to register a RobotFarm app so that Product can run/schedule TaskRobots on a VM (Virtual Machine) image created in RobotFarm.
Procedure
As a prerequisite, Product and RobotFarm must be installed.
- The Product license should have the RobotFarm flag set to "on".
- Create a registration entry with "app.type" as BOTFARM and the URL of RobotFarm server.
- On Save, the RobotFarm app will be registered with Product upon verification.
Register a Cognitive platform server with Product
- Audience & purpose
- The Cognitive Document Digitization Server needs to be registered with Product for the consumption of authentication, licensing, and audit log services provided by it.
Procedure
If an IQRobot license is enabled, the "Cognitive Platform" appears as an entry in "App Management". See the following screenshot.
- Enter the URL and other necessary details of the Cognitive Platform Server to register it with Product.
- If the registration is not successful you will be notified about it.
- Audit entries will be created of the number of "My App" registration attempts.
- You are now able to login to the Cognitive Platform Server and successfully post a registration by using a user created on Product.