Ir para o conteúdo

Arquivos de resultados

Ir para Arq. de resultados

Usando o BotCity Maestro SDK, você pode fazer upload de artefatos para o Orquestrador BotCity para disponibilizá-los para outros usuários ou aplicativos via portal da Web ou via API.

Arquivos de resultado

Chamamos esses arquivos de artefatos porque são resultados da execução de uma tarefa e podem ser qualquer tipo de arquivo.

Dica

Explore o Gerador de Snippet para obter exemplos de código que facilitam as manipulações de arquivos de resultados, acesse e aprenda como enviar um artefato, listar todos os artefatos e baixar um artefato via código.

Os snippets gerados estão disponíveis nas linguagens Python, Java, JavaScript e TypeScript.

Como utilizar arquivos de resultado com o Maestro SDK

Você pode facilmente carregar arquivos de resultados para a plataforma usando o Maestro SDK no código da sua automação.

Instalação do SDK

Caso você ainda não tenha a dependência instalada, basta seguir essas instruções:

pip install botcity-maestro-sdk

Importante

Além de instalar, lembre-se de incluir a dependência no arquivo requirements.txt do bot.

<repositories>
    <repository>
        <id>nexus-botcity-public</id>
        <url>https://devtools.botcity.dev:8081/repository/botcity-public/</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

<dependencies>
    <!-- Your other dependencies -->
    <dependency>
        <groupId>dev.botcity</groupId>
        <artifactId>maestro-sdk</artifactId>
        <version>2.0.3</version>
    </dependency>
</dependencies>

npm i @botcity/botcity-maestro-sdk

npm i @botcity/botcity-maestro-sdk

dotnet add package BotCity.Maestro.SDK

Importando o SDK

Após a instalação, basta importar a dependência e instanciar o Maestro SDK:

# Importando a dependência do Maestro SDK
from botcity.maestro import *

# Desabilitando erros caso não exista conexão com o Orquestrador
BotMaestroSDK.RAISE_NOT_CONNECTED = False

# Instanciando o Maestro SDK
maestro = BotMaestroSDK.from_sys_args()
# Buscando os detalhes da tarefa atual sendo executada
execution = maestro.get_execution()

// Importando a dependência do Maestro SDK
import dev.botcity.maestro_sdk.*;
...

public void action(BotExecution botExecution) {

    try {
        // Instanciando o Maestro SDK
        BotMaestroSDK maestro = new BotMaestroSDK();
        maestro.login(botExecution);
    ...

// Importando a dependência do Maestro SDK
const { BotMaestroSdk } = require('@botcity/botcity-maestro-sdk')

// Obtendo parâmetros passados pelo Runner
const args = process.argv.slice(2)
const [server, taskid, token] = args

// Login com as informações da página Amb. Desenvolvedor
const maestro = new BotMaestroSdk()
maestro.login("YOUR_SERVER_HERE", "YOUR_USER_HERE", "YOUR_KEY_HERE")

// Buscando os detalhes da tarefa atual sendo executada
const executionTask = await maestro.getTask(taskid)

// Importando a dependência do Maestro SDK
import { BotMaestroSdk } from '@botcity/botcity-maestro-sdk'

// Obtendo parâmetros passados pelo Runner
const args = process.argv.slice(2)
const [server, taskid, token] = args

// Login com as informações da página Amb. Desenvolvedor
const maestro: BotMaestroSdk = new BotMaestroSdk()
maestro.login("YOUR_SERVER_HERE", "YOUR_USER_HERE", "YOUR_KEY_HERE")

// Buscando os detalhes da tarefa atual sendo executada
const executionTask: Task = await maestro.getTask(taskid)

// Importando a dependência do Maestro SDK
using Dev.BotCity;
using Dev.BotCity.MaestroSdk.Model.Execution;

// Instanciando o Maestro SDK
BotMaestroSDK maestro = BotMaestroSDK.FromSysArgs();
// Buscando os detalhes da tarefa atual sendo executada
Execution execution = await maestro.GetExecutionAsync(maestro.GetTaskId());

Enviando um arquivo de resultado

# Enviando um arquivo de resultado (artefato) para o Orquestrador
maestro.post_artifact(
    task_id=execution.task_id,
    artifact_name="Meu artefato.png",
    filepath="screenshot.png"
)

// Enviando um arquivo de resultado (artefato) para o Orquestrador
File artifact = new File("screenshot.png");
maestro.postArtifact(botExecution.getTaskId(), "Meu artefato.png", artifact);

// Enviando um arquivo de resultado (artefato) para o Orquestrador
const filepath = "screenshot.png"
const artifact = await maestro.createArtifact(executionTask.id, "Meu artefato.png", filepath)

// Enviando um arquivo de resultado (artefato) para o Orquestrador
const filepath: string = "screenshot.png"
const artifact: Artifact = await maestro.createArtifact(executionTask.id, "Meu artefato.png", filepath)

// Enviando um arquivo de resultado (artefato) para o Orquestrador
await maestro.PostArtifactAsync(
    execution.TaskId,
    "Meu artefato.png",
    "screenshot.png"
);

Código completo

from botcity.core import DesktopBot
from botcity.maestro import *

# Desabilitando erros caso não exista conexão com o Orquestrador
BotMaestroSDK.RAISE_NOT_CONNECTED = False

def main():
    maestro = BotMaestroSDK.from_sys_args()
    execution = maestro.get_execution()

    bot = DesktopBot()

    # Tira e salva uma screenshot no caminho fornecido
    bot.save_screenshot("screenshot.png")

    # Enviando um arquivo de resultado (artefato) para o Orquestrador
    maestro.post_artifact(
        task_id=execution.task_id,
        artifact_name="Meu artefato.png",
        filepath="screenshot.png"
    )

    # Implemente aqui a sua lógica...
    ...

def not_found(label):
    print(f"Element not found: {label}")

if __name__ == '__main__':
    main()

import dev.botcity.framework.bot.DesktopBot;
import dev.botcity.maestro_sdk.BotExecutor;
import dev.botcity.maestro_sdk.BotMaestroSDK;
import dev.botcity.maestro_sdk.model.AlertType;
import dev.botcity.maestro_sdk.runner.BotExecution;
import dev.botcity.maestro_sdk.runner.RunnableAgent;

public class FirstBot extends DesktopBot implements RunnableAgent
{
    public FirstBot() {
        try {
            setResourceClassLoader(this.getClass().getClassLoader());
        } catch(Exception e) {
            e.printStackTrace();
        }
    }

    @Override
    public void action(BotExecution botExecution) {

        try {
            BotMaestroSDK maestro = new BotMaestroSDK();
            maestro.login(botExecution);

            // Tira e salva uma screenshot no caminho fornecido
            saveScreenshot("screenshot.png");

            // Enviando um arquivo de resultado (artefato) para o Orquestrador
            File artifact = new File("screenshot.png");
            maestro.postArtifact(botExecution.getTaskId(), "Meu artefato.png", artifact);

            // Implemente aqui a sua lógica...
            ...

        } catch(Exception e) {
            e.printStackTrace();
        }
    }

    private void notFound(String label) {
        System.out.println("Element not found: "+label);
    }

    public static void main(String[] args) {
        BotExecutor.run(new FirstBot(), args);
    }
}

const main = async () => {
    const { BotMaestroSdk } = require('@botcity/botcity-maestro-sdk')

    const args = process.argv.slice(2)
    const [server, taskid, token] = args

    const maestro = new BotMaestroSdk()
    maestro.login("YOUR_SERVER_HERE", "YOUR_USER_HERE", "YOUR_KEY_HERE")

    const executionTask = await maestro.getTask(taskid)

    const desktopBot = new DesktopBot()

    // Tira e salva uma screenshot no caminho fornecido
    const filepath = await desktopBot.screenshot('/home/user/', 'screenshot.png')

    // Enviando um arquivo de resultado (artefato) para o Orquestrador
    const artifact = await maestro.createArtifact(executionTask.id, "Meu artefato.png", filepath)
    }

main()

const main = async () => {
    import { BotMaestroSdk } from '@botcity/botcity-maestro-sdk'

    const args = process.argv.slice(2)
    const [server, taskid, token] = args

    const maestro: BotMaestroSdk = new BotMaestroSdk()
    maestro.login("YOUR_SERVER_HERE", "YOUR_USER_HERE", "YOUR_KEY_HERE")

    const executionTask: Task = await maestro.getTask(taskid)

    const desktopBot = new DesktopBot()

    // Tira e salva uma screenshot no caminho fornecido
    const filepath = await desktopBot.screenshot('/home/user/', 'screenshot.png')

    // Enviando um arquivo de resultado (artefato) para o Orquestrador
    const artifact: Artifact = await maestro.createArtifact(executionTask.id, "Meu artefato.png", filepath)
}

main()

using Dev.BotCity.MaestroSdk.Model.AutomationTask;
using Dev.BotCity.MaestroSdk.Model.Execution;
using System;
using System.Threading.Tasks;

namespace FirstBot
{
    class Program
    {
        static async Task Main(string[] args)
        {
            BotMaestroSDK maestro = BotMaestroSDK.FromSysArgs();
            Execution execution = await maestro.GetExecutionAsync(maestro.GetTaskId());

            Console.WriteLine("Task ID is: " + execution.TaskId);
            Console.WriteLine("Task Parameters are: " + string.Join(", ", execution.Parameters));

            // Enviando um arquivo de resultado (artefato) para o Orquestrador
            await maestro.PostArtifactAsync(
                execution.TaskId,
                "Meu artefato.png",
                "screenshot.png"
            );

            // Implemente aqui a sua lógica...
        }
    }
}

Dica

Consulte as outras operações que podemos fazer com arquivos de resultado utilizando o BotCity Maestro SDK e BotCity Orquestrador API.