Search

Execution Bots

Articles

The Execution Bots dashboard displays the status and other information of Execution Bots.

Image description

Clicking on the Bot Management option on the menu bar of the Tenant Admin view, the Execution Bots screen is displayed with the details of all the Bots created in the application.

  • ID: ID of the Bot.
  • Name: Name of the Bot.
  • Machine: Machine name is the combination of FQDN and Unique ID. It is a drop-down with the list of FQDNs (Fully Qualified Domain Name) and Unique ID that will be extracted from the list of registered machines in the Jiffy server once the client installation is completed. The number of machines that are registered in the server are also displayed.
  • Version: The version of the client package. Read more about this here.
  • Started by: The name of the Tenant Admin who started the Bot.
  • Status: The status of each Bot.
    • At Rest: The Bot and the Windows services are started but no tasks are currently being executed.
    • Starting: The Bot is about to start on clicking the Start button provided against each Bot.
    • Running: The Bot and the Windows services are started. Tasks associated with the Bot are getting executed.
    • Stopping: The Bot which is running is about to stop on clicking the Stop button.
    • Updating: The client version upgrade is going on.
    • Not Running: The Windows service is started, and the Bot is not started.
    • Not Available: Both windows service and the Bot are not started.
  • Last Executed: Details of when the Bot was last used. It could be any of the following:
    • Under Execution: The Bot currently executing its tasks.
    • Timestamp: Timestamp of the last executed task that was executed using that Bot.
  • Actions: Different actions that can be performed on the respective Bots.
    • Start/Stop: The Bot can be started and stopped by clicking on this icon.
    • Edit: The Bot can be edited by clicking on the Edit icon.
    • Delete: The Bots can be deleted by clicking on the Delete icon.

Bot Status In Detail

This table provides the details of the Bot status and the enabled/disabled state of various icons provided against each Execution Bot:

Bot Status Start / Stop Edit Delete Tooltip
Not Available No Yes Yes Please check if the windows service is running on the machine.
Not Running Yes Yes Yes Bot is not started. Please start the Bot or use the login node.
Starting No No No Start requested at ‘timestamp’.
At Rest Yes No No Windows Services and Bot are Started, but no task is getting executed
Running Yes No No No tooltip but info icon with details of tasks getting executed must be
provided in the popup window that is opened upon clicking on the alert icon.
Stopping No No No Stop requested at ‘timestamp’

Add New Bot

Bots can be added from the Bots console. Newly added Bots get auto-registered in the Jiffy server. The ports to be associated with a Bot are picked automatically from the available free ports whenever the Bot is started.

To add a new Bot, do the following:

  1. Click on the + icon (2) at the top right corner of the window.
  2. In the Add Bot dialog box that appears, specify the following details:
    Image description

    • Name: Name of the Bot. This is a unique value specific to each Bot.
    • Machine: Machine name is the combination of FQDN and Unique ID. It is a drop-down with the list of FQDNs (Fully Qualified Domain Name) and Unique ID that will be extracted from the list of registered machines in the Jiffy server once the client installation is completed. The number of machines that are registered in the server can also be known.
    • Capabilities: It is a list of automation capabilities. The user can select one or more options based on the required automation capability of that Jiffy Service. The various automation capabilities are:
      • SAP
      • Web
      • Putty
      • Desktop
      • Excel
      • Java
      • Mainframe
      • PDF
      • ALL: Includes all the automation capabilities
    • JVM Parameters: This allows the user to override the default values of the parameters. Click the Info icon for more details on JVM parameters and how to set up a bot. The following are the valid JVM parameters for starting a bot.
      • -Xmxm: The user can specify the memory to a bot using this parameter. Example: -Xmx1400m
      • Djiffy.mode: The default mode is “run”. If the user wants to debug, then the mode can be changed to “debug”. Example: -Djiffy.mode=debug
      • Djiffy.ocr.threshold: OCR character threshold. Example: jiffy.ocr.threshold = 250
      • Djiffy.ocr.conversionTimeout: The default time is 3 min. If conversion timeout must be increased, then change the value in milliseconds. Example: jiffy.ocr.conversionTimeout = 300000

        While creating or editing a machine, the user must add the -Dfile.encoding=utf-8 code in the JVM parameters text box. So, the user must make sure that the -Dfile.encoding=utf-8 code in the JVM parameters text box is available before starting a machine.

    • Username: The Username field is used for Login and Logoff nodes execution. The user can edit this field and provide a specific username, if the machine is being used in login and logoff nodes.
    • Password: The Password field is used for Login and Logoff nodes execution. The user can edit this field and provide a specific password, if the machine is being used in login and logoff nodes.

    The username and password can be provided manually or by enabling the Lock icon to use the Secure vault keys.

  3. Click on the SAVE button.

Start/Stop Procedure

  1. Click on the Start icon provided against each Bot under the Actions column in the Bots console. 
  2. Once the Bot starts, the status of the Bot will be updated as:
    • Running if any task is being executed.
    • At Rest if NO task is being executed.
  3. The Bot can be terminated at any time by clicking on the Stop icon provided against each Bot that has already started. 
  4. On clicking on the Stop icon, the Do you want to terminate? dialog box appears with the following choices:
    • Yes, Gracefully: The execution of the current node will be completed, and the Bot gets terminated gracefully. 
    • Yes, Immediately: The Bot will be terminated ungracefully. The execution of the current node will be stopped abruptly.

Client Version Upgrade

An Upgrade icon is provided against each Bot next to the value of the Version number under the Version column of the Bots console. The Upgrade icon will be enabled if the version of the client and server is not matching. Clicking on it, the client version gets upgraded.

The Bot must be stopped before upgrading the latest version. After the completion of the client version upgrade, the client machine must be restarted.

Did you find what you were looking for?