Como agendar Tarefas de API

Agendar uma Tarefa de API permite iniciar automações independentes de infraestrutura de Executor de bots (usuários e dispositivos). Como as Tarefas de API são executadas na Nuvem, a necessidade de licenças de usuários individuais é eliminada, economizando custos e simplificando o gerenciamento da automação.

Nota: Agendar Tarefas de API na Control Room exige a licença Enterprise Platform. Para mais informações sobre a versão compatível com este recurso, consulte Enterprise Platform.
É possível agendar as Tarefas de API disponíveis para serem executadas em um momento específico. Por exemplo, processar um lote de faturas em um arquivo .csv para execução todas as quartas-feiras às 17h.

Pré-requisitos

Verifique se fez o login na Control Room como administrador ou usuário com as seguintes permissões:
  • Agendar execução dos meus bots
  • Permissão Gerenciar TODAS as atividades agendadas nas minhas pastas de nível da pasta para Tarefa de API específica e quaisquer dependências
  • Execute como usuário Tarefas de API.

    Para obter mais informações, consulte Executar como usuário para a Tarefa de API (apitaskrunner).

Procedimento

  1. Faça login na Control Room.
  2. Selecione um dos métodos a seguir no painel esquerdo para criar um agendamento:
    • Clique em Automação.

      Clique no menu de ações (reticências verticais) à direita de Tarefa de API para o qual você deseja criar uma programação e clique em Programar tarefa de API.

    • Clique em Gerenciar > Agendado > Criar agendamento.
    A tela Automação e dependências é exibida. Você também pode clicar na opção Escolher para encontrar a Tarefa de API específica.
  3. Selecione a Tarefa de API que você deseja programar e clique em Escolher.
    A tela Criar agendamento é exibida com várias guias.
  4. Use a guia Automação e dependências para revisar e atualizar os seguintes campos:
    • Arquivo de automação: Exibe a Tarefa de API selecionada.

      Se quiser selecionar uma Tarefa de API diferente, clique em Escolher.

    • Executar automação e dependências usando: Selecione uma das seguintes versões da Tarefa de API para executar:
      • Versão mais recente: Programa a Tarefa de API selecionada e as dependências usando a versão mais recente.
      • Rótulo de produção: Programa a Tarefa de API selecionada e as dependências usando a versão de produção.

      Por padrão, a última versão do Tarefa de API é selecionado.

    • Dependências: Lista de dependências da Tarefa de API selecionada.
  5. Clique em Avançar.
  6. Adicione os detalhes do agendamento para a Tarefa de API.
    No campo Agendar, selecione uma das seguintes opções:
    • Executar uma vez: Executa a Tarefa de API uma vez no dia e hora especificados.

      Use as seguintes opções para definir a configuração de Executar uma vez:

      • Data de início: O valor padrão é o dia atual.
      • Hora de início: O valor padrão é arredondado para a próxima meia hora.
      • Fuso horário: Fuso horário do sistema no dispositivo local.
        Nota: Os fusos horários EST, HST ou MST estão obsoletos. Consulte Próximas descontinuações de recursos.
    • Executar repetidamente: Use essa opção para programar a Tarefa de API para executar no dia e hora especificados.

      Use as seguintes opções para definir a configuração de Executar repetidamente:

      • Data de início: Insira a data em que deseja que a programação comece a executar o Tarefa de API.

        Insira a data manualmente no formato AAAA-MM-DD ou usando o calendário pop-up. O valor padrão do campo Data de início é definido para o dia atual definido no dispositivo local.

      • Data de término: Insira a data em que deseja que a programação termine.

        A Data de término não será definida por padrão.

      • Hora de início: Insira a Hora de início usando a lista suspensa para definir o valor da hora em que deseja que sua programação comece.

        A lista contém valores de tempo predefinidos no formato de 12 horas, em intervalos de 15 minutos. Você também pode definir manualmente o valor de tempo no formato de 12 horas.

      • Fuso horário: Selecione o fuso horário para as horas de início e de término.

        O valor padrão é definido para a localização atual do sistema. Uma programação é executada com base no fuso horário selecionado ao criar ou editar uma programação.

      • Repetir a cada: Selecione a opção para repetir o agendamento.
    • Frequência: Selecione uma das seguintes opções como a frequência de execução do agendamento:
      • Diariamente: Selecione o número de dias que você deseja que a programação seja executada.
      • Semanalmente: Selecione as semanas e os dias específicos da semana em que deseja que a programação seja executada.

        Por exemplo, se desejar que a programação seja executada a cada 2 semanas, na segunda-feira e na quinta-feira, aumente a contagem para 2 na opção A cada e marque as caixas de seleção Segunda-feira e Quinta-feira.

      • Mensalmente: Selecione uma das seguintes opções:
        • Dia: Selecione o dia do mês em que deseja que a programação seja executada.
        • O: Selecione uma ocorrência específica do dia do mês em que deseja que a programação seja executada.

          Por exemplo, se desejar que o agendamento seja executado na segunda quinta-feira dos meses de janeiro, maio e setembro, selecione a segunda quinta-feira e janeiro, maio e setembro nas opções indicadas.

        Nota: Quando o horário de verão for ativado e se a Data de início estiver agendada, a data é mostrada no respectivo fuso horário (e não conforme o fuso horário atual do usuário). No entanto, a Próxima ocorrência é mostrada no fuso horário (fuso horário do sistema do usuário) conforme o horário de verão.

        Por exemplo, para um horário criado em 15 de março no fuso horário GMT, a Data de início é mostrada como Mar-15th, que pertence ao fuso horário GMT. Depois, quando o horário de verão estiver ATIVADO e se você editar ou exibir este agendamento no mês de agosto no fuso horário BST, a próxima ocorrência é mostrada como "Agosto" no fuso horário BST.

        Se agendar a tarefa para executar das 9h de 23/11/2023 às 9h de 30/11/2023, com frequência definida como diária, a tarefa será executada diariamente a partir das 9h de 23/11/2023, e a última execução da tarefa será às 9h de 30/11/2023.

    • Na seção Configuração de agendamento perdida, marque a caixa de seleção Reimplantar o agendamento para reimplantar um agendamento que foi perdido devido a desligamento da Control Room.

      Quando a opção Reimplantar o agendamento for selecionada, os agendamentos perdidos porque desligamentos da Control Room são reimplantados de forma automática depois que a Control Room é reiniciada. Um registro de auditoria também é adicionado mostrando o Tipo de evento como Schedule misfired.

      Nota: Para garantir uma implantação bem-sucedida ao usar a opção Reimplantar o cronograma, você deve iniciar o serviço do compilador antes de reiniciar os serviços da Control Room.
  7. Clique em Avançar.
  8. Use a guia Executar como usuário para o seguinte:
    • Selecione os usuários na lista da tabela Usuários disponíveis para execução e clique na seta para baixo para adicionar sua seleção.

      Os usuários que você selecionou são listados na tabela Selecionados . Você pode usar a seta para cima para remover qualquer um dos usuários selecionados.

      Nota: O sistema gera um usuário chamado apitaskrunner que está associado à função AAE_API Task Runner para estabelecer o contexto de usuário run-as para Tarefas de API.
    • No campo Definir número de usuários para execução a serem usados, selecione uma das seguintes opções:
      • Todos os usuários para execução: Selecione esta opção para especificar todos os usuários disponíveis na tabela Selecionada como executar como usuário durante a execução do Tarefa de API.
      • Número personalizado de usuários para execução: Selecione esta opção para fornecer um determinado número de usuários da tabela Selecionada que você deseja usar como executar como usuário.

        Por exemplo, se você tiver 5 usuários na tabela Selecionado e quiser usar apenas 3 como executar como usuário, insira 3. Os 3 usuários listados no topo da tabela são usados como executar como usuário durante a execução do Tarefa de API.

  9. Clique em Avançar.
  10. Opcional: Use a guia Geral para alterar a configuração padrão das seguintes opções:
    • Nome da atividade: Edite ou renomeie a Tarefa de API.
    • Prioridade de automação: Clique no menu suspenso para definir a prioridade de automação.

      Embora Média seja a prioridade de automação padrão, você pode alterá-la para que as automações sejam processadas para implantação de forma adequada.

  11. Clique em Criar agendamento.
    A Tarefa de API está agendada. Você pode visualizar o status do agendamento das Tarefas de API na página Gerenciar > Agendado.