Analyze package

Use the actions in the Analyze package to specify the actions and variables to use in the Bot Insight dashboard and widgets. The Analyze package enables you to perform transactional analytics for the data that is logged by the variables when the bot runs.

Note: The proxy configuration with authentication is currently not supported.
  • To download an individual package (updated in an Automation 360 release where you want only the package), use this URL:

    https://aai-artifacts.my.automationanywhere.digital/packages/<package-file-name>-<version.number>.jar

  • For Analyze package, the naming convention is: bot-command-analyze-<version.number>.jar

    For example, bot-command-analyze-2.8.0-20230427-091823.jar

For detailed steps on downloading a package and manually adding it to the Control Room, see Add packages to the Control Room.

Actions in the Analyze package

The Analyze package includes the following actions:

Action Description
Close Closes a transaction.
  • In the Transaction name field, enter the transaction name that you provided in the Open action.
  • In Dictionary variable, select the following options:
    • All user-defined variables: Include all the user-defined string, numeric, and datetime variables from the bot to populate the Bot Insight dashboards.
    • Manually select the variables to include in the Bot Insight dashboards.
Open Opens a transaction. Insert the actions that you want to include for analysis between the Open and Close actions. In the Transaction name field, enter a transaction name.
Using the Open and Close actions with the Loop package
  • If you want to capture all the data within the loop in the Bot Insight dashboard, use the Open and Close actions inside the loop.

    Example: If you are using the For each row in CSV/TXT iterator in the Loop action to read values from each row in a Microsoft Excel sheet, use the Open and Close actions inside this loop to analyze and capture the data of each row in the Bot Insight dashboard.

  • If you want to capture only the last interpreted data of the loop in the Bot Insight dashboard, use the Open and Close actions outside the loop.

    Example: If you are using the For each row in CSV/TXT iterator in the Loop action to read values from each row in a Microsoft Excel sheet, use the Open and Close actions outside this loop to capture only the data in the last row of the Excel sheet in the Bot Insight dashboard.

Using the Open and Close actions with the Error handler and If packages
  • If you want to analyze and capture error messages during bot execution in the Bot Insight dashboard, use the Open and Close actions with an Error handler package.
    Example:
    1. Create a bot with multiple If actions within a loop.
    2. To capture errors, within every If action, add an Error Handler > Catch action.
    3. Inside the loop, after every If action, add the Analyze > Close action to capture the errors inside every If condition on the Bot Insight dashboard for analysis.
Example task: See the following topic for an example of building a bot to retrieve data from a website to create visualizations in Bot Insight: Build a Bot Insight dashboard bot. The example includes using the Open and Close actions inside a loop when using the For each row in CSV/TXT iterator in the Loop action.