Overview
The Execution Orchestrator - Start operation in this node allows users to initiate the execution of a bot within the Automation Anywhere platform. This is useful for automating workflows by programmatically triggering bots with specific configurations and inputs.
Common scenarios include:
- Starting a bot to process data or perform tasks on demand.
- Running bots on specific devices or device pools based on availability or preference.
- Passing custom input parameters to bots dynamically.
- Receiving callback notifications about the bot execution status via webhooks.
For example, you might use this node to start a data extraction bot on a preferred device pool, supplying it with variables such as file paths or user IDs, and receive updates on its progress through a callback URL.
Properties
| Name | Meaning |
|---|---|
| Bot ID | The numeric identifier of the bot you want to start. |
| Bot Runners IDs | Select one or more user IDs under which the bot will run. These can be chosen from a list or specified using expressions. |
| Device Configuration | How the bot should be assigned to devices: - Prefer Default Device - Run Only on Default Device - Run on Pool Device(s) |
| Additional Fields | A collection of optional fields to customize the bot execution: • Bot Inputs: Key-value pairs of input variables with types (String, Number, Boolean) to pass to the bot. • Callback Headers: Custom headers for callback requests. • Callback Url: URL to receive execution status callbacks. • Device Pools IDs: IDs of device pools where the bot can run. • Hide Bot Run Window: Whether to hide the bot's UI window during execution. • Label: Label for the bot deployment. • Name: Name for the automation instance. • Number of Bot Runners to Use: How many bot runners to allocate. • Priority: Execution priority (High, Medium, Low). • Run with Administrative Privileges: Whether to run the bot elevated. |
Output
The node outputs JSON data representing the response from the Automation Anywhere API after attempting to start the bot execution. This typically includes details such as:
- Execution identifiers
- Status of the start request
- Any error messages if the start failed
If the bot execution involves binary data (not indicated here), it would be handled accordingly, but this node primarily deals with JSON responses related to execution orchestration.
Dependencies
- Requires an API key credential for Automation Anywhere with appropriate permissions.
- Needs network access to the Automation Anywhere API endpoint configured in the credentials.
- Uses internal methods to fetch lists of available bot runners and device pools dynamically for property options.
Troubleshooting
- Invalid Bot ID or Bot Runner IDs: Ensure that the provided IDs exist and are accessible by your API credentials.
- Device Configuration Conflicts: Selecting incompatible device usage types or empty device pools may cause failures.
- Missing Required Fields: Bot ID, Bot Runners IDs, Device Configuration, Number of Bot Runners to Use, and Hide Bot Run Window are required; missing these will cause errors.
- Callback URL Issues: If using callbacks, ensure the URL is reachable and correctly handles incoming requests.
- Permission Errors: Running bots with administrative privileges requires proper rights; lack thereof may cause execution failure.
- API Rate Limits or Network Errors: May result in request failures; check connectivity and API quotas.