> ## Documentation Index
> Fetch the complete documentation index at: https://ai-kb.automationanywhere.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Automation Anywhere Toolkit

> Implemente e gerencie bots do Automation Anywhere a partir de um workflow.

O **Automation Anywhere Toolkit** permite que seus workflows interajam com o APA Control Room da Automation Anywhere — implementando bots, monitorando seus status, recuperando suas saídas, listando bots disponíveis e cancelando execuções ativas.

## Autenticação

Todas as ferramentas da Automation Anywhere requerem uma conexão com o Control Room. Cada ferramenta inclui um seletor **Connection**. Se nenhuma conexão estiver configurada, clique em **Add Connection** para criar uma.

Ao criar uma conexão, forneça o seguinte:

| Campo                      | Obrigatório | Descrição                                                                                                          |
| -------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------ |
| **Connection Name**        | Sim         | Um rótulo para identificar esta conexão (por exemplo, `control-room-connection`).                                  |
| **Control Room URL**       | Sim         | A URL do seu Control Room da Automation Anywhere (por exemplo, `https://your-company.automationanywhere.digital`). |
| **Username**               | Sim         | Seu nome de usuário da Automation Anywhere.                                                                        |
| **Authentication Version** | Sim         | Selecione `V2 Authentication` para usar uma API Key, ou `V1 Authentication` para usar uma senha.                   |
| **Credential**             | Sim         | Sua API Key (para V2) ou senha (para V1). Digite `@` para referenciar um segredo do vault.                         |

## Ferramentas

### Deploy Bot

Implementa um bot da Automation Anywhere a partir do Control Room conectado.

| Campo                      | Obrigatório | Descrição                                                                                                                                                                                                                                                                                                                                                                                  |
| -------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Connection**             | Sim         | Selecione uma conexão configurada do Control Room.                                                                                                                                                                                                                                                                                                                                         |
| **Bot Id**                 | Sim         | O ID do bot a ser implementado. Digite `@` para selecionar uma variável.                                                                                                                                                                                                                                                                                                                   |
| **Automation Name**        | Não         | Nome da automação. O padrão é `null`.                                                                                                                                                                                                                                                                                                                                                      |
| **Automation Description** | Não         | Descrição da automação sendo implementada. O padrão é `null`.                                                                                                                                                                                                                                                                                                                              |
| **Bot Input**              | Não         | Array de entradas para o bot. Clique em **Add Item** para adicionar entradas, ou habilite **JSON Mode** para colar dados ou usar variáveis `@`. O padrão é `null`.                                                                                                                                                                                                                         |
| **Deployment Type**        | Não         | Tipo de solicitação de implantação. Opções: `Attended Request`, `Unattended Request`, `Headless Request`. O padrão é `Unattended Request`.                                                                                                                                                                                                                                                 |
| **Run As User Ids**        | Não         | Array de IDs de usuário para executar o bot. O bot será implantado em um dos dispositivos da lista fornecida. Digite `@` em qualquer item para referenciar uma variável. O padrão é `null`.                                                                                                                                                                                                |
| **Pool Ids**               | Não         | Array de IDs de pool especificando o número de usuários run-as a usar. Digite `@` em qualquer item para referenciar uma variável. O padrão é `null`.                                                                                                                                                                                                                                       |
| **Num Of Run As Users**    | Não         | Quantos usuários run-as devem ser usados da lista `Run As User Ids`. Se não especificado, a implantação acontecerá em todos os dispositivos disponíveis na lista. O padrão é `0`.                                                                                                                                                                                                          |
| **Launch In Child Window** | Não         | Especifica como os dispositivos de implantação são selecionados. Opções: `RUN_ONLY_ON_DEFAULT_DEVICE` — apenas o dispositivo padrão é usado; `PREFER_DEFAULT_DEVICE` — prioriza o dispositivo padrão e, se indisponível, usa outro dispositivo do pool; `RUN_ON_POOL_DEVICES` — o bot será implantado em qualquer dispositivo disponível do pool. O padrão é `RUN_ONLY_ON_DEFAULT_DEVICE`. |
| **Continue On Failure**    | Não         | Se `true`, pula esta etapa e continua o workflow normalmente se falhar. O padrão é `false`.                                                                                                                                                                                                                                                                                                |
| **Retry On Failure**       | Não         | Se `true`, repete automaticamente até quatro tentativas quando a etapa falha. O padrão é `false`.                                                                                                                                                                                                                                                                                          |

### Get Bot Status

Recupera o status de execução atual de um bot implantado.

| Campo               | Obrigatório | Descrição                                                                                                               |
| ------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------- |
| **Connection**      | Sim         | Selecione uma conexão configurada do Control Room.                                                                      |
| **Deployment Id**   | Sim         | O ID de implantação para verificar o status. Digite `@` para selecionar uma variável.                                   |
| **Poll Until Done** | Não         | Quando habilitado, continua verificando o status do bot até que ele termine ou falhe, em vez de retornar imediatamente. |

### Get Bot Output

Recupera a saída retornada por uma implantação concluída de bot.

| Campo             | Obrigatório | Descrição                                                                        |
| ----------------- | ----------- | -------------------------------------------------------------------------------- |
| **Connection**    | Sim         | Selecione uma conexão configurada do Control Room.                               |
| **Deployment Id** | Sim         | O ID de implantação para obter a saída. Digite `@` para selecionar uma variável. |

### List Bots

Recupera uma lista de bots disponíveis no Control Room conectado.

| Campo           | Obrigatório | Descrição                                          |
| --------------- | ----------- | -------------------------------------------------- |
| **Connection**  | Sim         | Selecione uma conexão configurada do Control Room. |
| **Filter Name** | Não         | Filtrar bots por nome. O padrão é `null`.          |
| **Limit**       | Não         | Número máximo de bots a retornar. O padrão é `50`. |

### Cancel Bot Execution

Cancela uma implantação de bot ativa no Control Room conectado.

| Campo             | Obrigatório | Descrição                                                                                        |
| ----------------- | ----------- | ------------------------------------------------------------------------------------------------ |
| **Connection**    | Sim         | Selecione uma conexão configurada do Control Room.                                               |
| **Deployment Id** | Sim         | O ID de implantação da execução do bot a ser cancelada. Digite `@` para selecionar uma variável. |
