Visão geral do console do Orchestration

Painel de Navegação

O painel de navegação à esquerda mostra a árvore Runbook e Pastas, como a mostrada no Runbook Designer. Ao contrário do console em versões anteriores, você não pode selecionar as pastas, mas pode selecionar os runbooks e exibir seus trabalhos e executá-los.

O painel de navegação está sempre visível em todas as telas para permitir a navegação rápida para outros runbooks e pastas, enquanto permanece na mesma tela.

À direita do painel de navegação, você pode ver a tela escolhida. A tela Painel é mostrada por padrão.

Painel

O Painel mostra os trabalhos Ativos na parte superior, seguidos por uma tabela de todos os trabalhos Concluídos (histórico). O painel Trabalhos concluídos (histórico) é recolhido por padrão, permitindo o foco nos trabalhos ativos.

Cada linha em ambos os painéis corresponde a um trabalho exclusivo. Um trabalho pode ter uma ou mais instâncias de runbook. Cada linha mostra:

• ID do trabalho: link para o runbook
• Carimbos de data/hora: o número de instâncias bem-sucedidas e com falha é mostrado em uma das colunas para todas as linhas.
• Botões de ação: Parar trabalho ou Exibir detalhes do trabalho.

Você pode selecionar e expandir cada uma das linhas de trabalho e exibir as instâncias do trabalho.

Runbooks

Quando você seleciona um runbook na árvore de navegação ou seleciona um link de runbook, o aplicativo navega até a tela Runbook. O painel superior lista os metadados do runbook (status de edição, carimbos de data/hora e assim por diante). O botão Executar permite que você enfileire o runbook para execução no subconjunto desejado de servidores runbook. O botão Executar está desabilitado para runbooks que não estão no estado Publicado .

Abaixo deste painel há uma exibição com guias:

• Exibir: para a imagem gráfica do Runbook.
• Trabalhos: para obter a lista de trabalhos ativos e concluídos do runbook (veja abaixo).
• Instâncias: para obter a lista de instâncias ativas e concluídas do runbook em todos os seus trabalhos (veja abaixo).

Você pode selecionar as linhas na visualização Trabalhos da mesma forma que as da tela Painel. Os trabalhos que estão em execução podem ser interrompidos usando os botões à direita da linha em execução.

Você pode selecionar as linhas na visualização Trabalhos da mesma forma que as da tela Painel. Os trabalhos que estão em execução podem ser interrompidos usando os botões à direita da linha em execução.

Enquanto essa tela estiver ativa, você poderá escolher um runbook diferente na árvore de navegação. Isso não alterará a guia selecionada. Você pode examinar os trabalhos de diferentes runbooks selecionando a guia Trabalhos e navegando até os runbooks desejados na árvore de navegação.

Trabalhos

Quando você seleciona um trabalho (usando o botão (i)), o aplicativo navega até essa tela. O painel superior mostra os metadados do trabalho (carimbos de data/hora, parâmetros).

Uma tabela que mostra as instâncias desse trabalho segue o painel.

A maioria dos trabalhos tem uma única instância. Se o runbook tiver uma atividade de gatilho Monitor/Evento, cada gatilho iniciará uma instância de trabalho exclusiva. A captura de tela a seguir mostra um trabalho com mais de uma instância.

O status do trabalho é mostrado visualmente com os ícones:

Instâncias

Quando você seleciona uma instância (usando o botão (i)), o aplicativo navega até essa tela. O painel superior mostra os metadados da instância (ID do trabalho, carimbos de data/hora, parâmetros, servidor que executa esta instância).

O painel superior também possui três botões de navegação:

• Anterior: Visualize a instância executada antes desta.
• Próximo: Visualize a instância que foi executada após esta.
• Mais recente: Exibir a instância mais atual.

Abaixo do painel, você verá o diagrama do runbook. Você pode selecionar cada atividade de runbook para exibir as saídas da atividade. Um ícone dedicado para cada atividade indica o status dessa atividade. Quando você seleciona qualquer atividade, um painel à direita lista as saídas da atividade.

Como uma atividade pode ser executada mais de uma vez em uma instância (devido ao loop), cada execução da atividade tem um número de sequência exclusivo. A sobreposição permite que você escolha a Sequência # usando o menu suspenso na parte superior.

O status da instância e da atividade segue o mesmo formato do status do trabalho.

Executar runbooks

Navegue até a tela Runbook do Runbook desejado e selecione Executar. Um formulário de sobreposição é aberto à direita, onde você é solicitado:

• Defina valores para todos os parâmetros de entrada (obrigatório).
• Escolha o conjunto de servidores Runbook no qual esse trabalho pode ser agendado.

Apenas um desses servidores executará este trabalho. Para executar um Runbook em muitos servidores, você precisará executar esses muitos trabalhos e definir explicitamente os servidores um por um.

Quando o formulário é enviado, um pop-up que desaparece é mostrado no canto superior direito para notificar se o trabalho foi enfileirado com sucesso ou não.

Parar de executar trabalhos

O botão Parar é mostrado no Painel e na tela Trabalho. O pop-up que desaparece no canto superior direito notifica se o trabalho foi interrompido ou não.

Perguntas Frequentes

O Console não carrega; erro "Uh oh! Problemas para se conectar ao WebApi [status 0]" é exibido.

1. Verifique o console do desenvolvedor do navegador (guia Console), procure erros de CORS (bloqueados pela política de CORS).

   

2. Se não houver erros de CORS, verifique os logs do Visualizador de Eventos (Aplicativo) no computador da API Web.

Para corrigir erros de CORS, você deve garantir que o arquivo da web.config API tenha uma configuração de CORS adequada. O erro do navegador mostra o valor de origem esperado no arquivo .web.config Embora os nomes de domínio não diferenciem maiúsculas de minúsculas, o IIS CORS usa o teste de comparação que diferencia maiúsculas de minúsculas. Verifique se o origin valor está em letras minúsculas na configuração do CORS do IIS.

<add allowCredentials="true" maxAge="7200" origin="http://{domain}[:{port}]">
  <allowMethods>
    <add method="GET"/>
    <add method="PUT"/>
    <add method="POST"/>
    <add method="PATCH"/>
    <add method="DELETE"/>
  </allowMethods>
  <allowHeaders allowAllRequestedHeaders="true"/>
</add>

Para obter detalhes sobre como configurar o CORS no web.config, consulte este artigo sobre Configuração do módulo CORS.

Como atualizar a URL da API Web?

O Console carrega {install_dir}\assets\configuration.json para localizar a URL da API. Você pode editá-lo usando um editor de texto sem formatação. Certifique-se de que não haja nenhuma barra / à direita no final do URL.

Painel de Navegação

O painel de navegação é o painel esquerdo na consola do Orchestrator, onde pode selecionar a área de trabalho que pretende utilizar. Dependendo do espaço de trabalho selecionado, você pode exibir dados específicos e usar opções específicas. Os workspaces a seguir estão disponíveis no painel de navegação.

Workspace Runbooks

O workspace Runbooks permite iniciar e parar runbooks. Você também pode ver informações como os trabalhos e instâncias criadas para cada runbook e suas definições.

Resumo

A guia Resumo é exibida para qualquer pasta ou runbook selecionado no workspace Runbooks. Essa guia exibe informações resumidas para os trabalhos e instâncias do runbook selecionado ou para todos os runbooks na pasta selecionada. As estatísticas exibidas são atualizadas a cada 10 minutos, portanto, a atividade realizada dentro desse tempo pode não ser refletida nos números até que sejam atualizadas.

Cada coluna em Resumo exibe o número de trabalhos e instâncias concluídas com um status específico (Êxito, Aviso ou Falha) na última hora, no último dia e na última semana. No caso das instâncias, também é exibido o número de instâncias que estão atualmente em andamento. No caso dos trabalhos, também é exibido o número de trabalhos que foram criados e estão atualmente na fila.

Runbooks

A guia Resumo é exibida quando você seleciona uma pasta no workspace Runbooks. Ela lista os runbooks contidos na pasta selecionada e especifica o status de quaisquer trabalhos e instâncias em execução de cada runbook. Para selecionar um desses runbooks e controlar suas ações, selecione uma opção no painel Ações . Se você tiver muitos runbooks, poderá refinar a lista especificando um filtro.

Trabalhos

A guia Trabalhos é exibida quando você seleciona uma pasta ou runbook no workspace Runbooks. Essa guia lista os trabalhos criados para um determinado runbook e o status de conclusão. No caso de pastas, ela lista os trabalhos criados para todos os runbooks na pasta e o status de conclusão. Um trabalho é uma solicitação para um servidor Runbook que execute o runbook, e é criado toda vez que um runbook recebe uma solicitação de execução. Se um runbook inicia com um monitor, ele cria o trabalho, que é executado continuamente até que o runbook seja parado. Nesse caso, o status do trabalho mostra uma ampulheta que indica que ele está em execução no momento.

Instâncias

A guia Instâncias será exibida se você selecionar uma pasta ou runbook no workspace Runbooks . No caso de runbooks, essa guia lista as instâncias que foram criadas para o runbook e o status de conclusão. No caso de pastas, ela lista as instâncias criadas para todos os runbooks na pasta e o status de conclusão. Uma instância é uma cópia em execução de um runbook e é criada sempre que esse runbook é executado. Se um runbook inicia com um monitor, ele cria uma instância, que continua a ser executada até que a condição do monitor seja cumprida. Nesse caso, o status da instância mostra uma ampulheta. Quando a condição do monitor for cumprida, a instância continuará com as atividades subsequentes e mostrará um status de conclusão. O runbook cria em seguida uma nova instância, que também é executada até que a condição do monitor seja atendida.

Workspace Servidores Runbook

O workspace Servidores Runbook permite visualizar o status de trabalhos e instâncias atuais e concluídos de cada servidor Runbook.

Trabalhos

A guia Trabalhos lista os trabalhos que foram executados no servidor Runbook e o status de conclusão. Um trabalho é uma solicitação para um servidor Runbook que execute o runbook, e é criado toda vez que um runbook recebe uma solicitação de execução. Se um runbook inicia com um monitor, ele cria o trabalho, que é executado continuamente até que o runbook seja parado. Nesse caso, o status do trabalho mostra uma ampulheta, o que significa que ele está em execução no momento.

Instâncias

A guia Instâncias lista as instâncias que foram criadas no servidor Runbook e o status de conclusão. Uma instância é uma cópia em execução de um runbook e é criada sempre que esse runbook é executado. Se um runbook inicia com um monitor, ele cria uma instância, que continua a ser executada até que a condição do monitor seja cumprida. Nesse caso, o status da instância mostra uma ampulheta. Quando a condição do monitor for cumprida, a instância continuará com as atividades subsequentes e mostrará um status de conclusão. O runbook cria em seguida uma nova instância, que também é executada até que a condição do monitor seja atendida.

Workspace Eventos

O workspace Eventos permite visualizar eventos de log. Por padrão, o log de eventos inclui todos os eventos para o servidor de management e todos os servidores Runbook. Para limitar os eventos, selecione Filtrar e forneça os critérios para limitar os eventos exibidos. Se um evento for específico de um servidor Runbook, ele incluirá o nome do servidor na caixa Fonte . Nesse caso, você pode selecionar o evento e, em seguida, selecionar Exibir Servidor Runbook no painel Ações. Selecionar Exibir Servidor Runbook abre a guia Trabalhos no espaço de trabalho Servidores Runbook para esse servidor runbook.

Inicie o console do Orchestration em um navegador

1. Abra seu navegador.

2. Na barra de endereços, digite http://computer name/:port number onde nome do computador é o nome do servidor onde o serviço Web está instalado e porta é o número da porta selecionado durante a configuração do serviço Web. Por padrão, a porta é 82.

Inicie o console de Orquestração no Runbook Designer

• Selecione o Orchestration Console na barra de ferramentas.

  Observação

  Se a URL não tiver sido definida para o console do Orchestration, você receberá uma mensagem de erro. Use o procedimento a seguir para definir o URL.

Definir a URL do console de orquestração no Runbook Designer

1. Selecione Opçõese selecione Orchestration Console.

2. Na caixa URL, digite http://computer name:port number onde nome do computador é o nome do servidor onde o serviço Web está instalado e porta é o número da porta selecionado durante a configuração do serviço Web. Por padrão, a porta é 82.

3. Selecione Concluir.

Iniciar e parar runbooks

Além de exibir o status de um runbook, você também pode iniciar e parar um runbook no console do Orchestration. Quando você inicia um runbook, um trabalho é criado e aguarda que um servidor Runbook processe o runbook. Se a primeira ação em um runbook for um monitor, o trabalho é executado de maneira contínua, potencialmente produzindo múltiplas instâncias de um runbook até que o runbook ou trabalho seja parado. Quando um servidor Runbook fica disponível. o trabalho fornece uma instância do runbook ao servidor para processamento. Um runbook em execução tem pelo menos um trabalho e uma ou mais instâncias associadas a ele.

Quando você para um runbook, o runbook, todos os trabalhos e todas as instâncias associadas a ele são parados.

Iniciar um runbook

1. Selecione Runbooks para abrir o workspace Runbooks.

2. Se o runbook estiver em uma pasta, selecione a pasta no painel Runbooks .

3. Selecione a guia Runbooks no painel de resultados.

4. Selecione o runbook e, no painel Ações , selecione Iniciar Runbook.

5. Se o runbook exigir parâmetros, eles serão listados no painel Parâmetros do Runbook. Selecione a coluna Valor para cada runbook e digite um valor para o runbook usar.

6. Se você quiser executar o runbook em um servidor diferente do padrão, selecione um servidor no painel Servidor(es) Runbook Disponível(is) e, em seguida, selecione a seta para a direita para adicionar o servidor ao painel Servidor(es) Runbook Selecionado(s).

   Observação

   Se você adicionar vários servidores ao painel Servidores Runbook Selecionados , o runbook será executado somente no primeiro servidor, se estiver disponível. Os outros servidores são servidores de backup em que o runbook será executado somente se o servidor primário não estiver disponível.

7. Selecione Iniciar.

Parar um runbook

1. Selecione Runbooks para abrir o workspace Runbooks.

2. Se o runbook estiver em uma pasta, selecione a pasta no painel Runbooks .

3. Selecione a guia Runbooks no painel de resultados.

4. Selecione o runbook e, no painel Ações , selecione Parar Runbook.

5. Selecione OK para a mensagem para confirmar que você deseja interromper os trabalhos.

6. Se o runbook foi iniciado com êxito, você receberá uma mensagem de confirmação de que o trabalho foi parado. Se o runbook não tiver nenhum trabalho em execução, você receberá uma mensagem de que nenhum trabalho estava sendo executado.

Exibir o status de um runbook no console do Orchestration

1. Selecione Runbooks para abrir o workspace Runbooks.

2. Se o runbook estiver em uma pasta, selecione a pasta no painel Runbooks .

3. Selecione a guia Runbooks no painel de resultados.

4. Selecione o runbook.

5. Para ver todos os trabalhos que o runbook criou, no painel Ações , selecione Visualizar trabalhos.

6. Para ver todas as instâncias que o runbook criou, no painel Ações , selecione Visualizar instâncias.

Parar trabalhos

Um trabalho é uma solicitação de execução de um runbook. O trabalho é criado somente quando você solicita a execução de um runbook. Se a primeira ação em um runbook for um monitor, o trabalho é executado de maneira contínua até que o runbook ou trabalho seja parado. Um símbolo de ampulheta indica o status de um trabalho em execução. Uma instância é uma cópia em execução de um runbook.

Você não pode começar um trabalho; Você só pode iniciar um runbook.

Quando você visualiza uma instância, pode optar por parar o trabalho associado. Parar o trabalho interrompe a instância, o trabalho e outras instâncias associadas, além do runbook.

Execute o seguinte comando do PowerShell para extrair o pacote de versão v10.19.350.0 do DLC e inicie Setup.exe:

Setup.exe /components:webapi,webconsole

Revise a documentação do instalador da API e do console e siga as etapas mostradas pelo Setup.exe.

O instalador criará automaticamente novos sites do IIS com novos web.configarquivos . Você pode ter feito alterações no web.config (como adicionar domínios a origens permitidas pelo CORS, configurações de banco de dados, outros elementos do site do IIS). Compare o anterior e o novo web.config e atualize o novo web.config conforme necessário.

A especificação da API (Swagger/OpenAPI) está incluída no formato .json e pode ser visualizada usando um visualizador de swagger de sua escolha, como o editor Swagger.

Siga as perguntas frequentes para solucionar problemas comuns. Quando estiver familiarizado com a versão v10.19.350.0, você poderá remover os aplicativos .NET 5 e os respectivos sites do IIS.

Como esta é uma nova instalação, talvez você queira examinar o site do IIS e web.config criado pelo instalador. Seria benéfico adicionar os domínios do console à lista de origens permitidas do CORS da API.

Execute o seguinte comando do PowerShell para extrair o pacote de versão v10.19.350.0 do DLC e inicie Setup.exe:

Setup.exe /components:webapi,webconsole

Revise a documentação do instalador da API e do console e siga as etapas mostradas pelo Setup.exe.

O instalador criará automaticamente novos sites do IIS com novos web.configarquivos . Você pode ter feito alterações no web.config (como adicionar domínios a origens permitidas pelo CORS, configurações de banco de dados, outros elementos do site do IIS). Compare o anterior e o novo web.config e atualize o novo web.config conforme necessário.

A especificação da API (Swagger/OpenAPI) está incluída no formato .json e pode ser visualizada usando um visualizador do Swagger de sua escolha, como o editor do Swagger.

Siga as perguntas frequentes para solucionar problemas comuns. Quando estiver familiarizado com a versão v10.19.350.0, você poderá remover os aplicativos .NET 5 e os respectivos sites do IIS.

Siga estas etapas para iniciar um runbook:

1. Selecione Runbooks para abrir o workspace Runbooks.

2. Se o runbook estiver localizado em uma pasta, selecione a pasta no painel Runbooks .

3. Selecione a guia Runbooks no painel de resultados.

4. Selecione o runbook e, no painel Ações , selecione Iniciar Runbook.

5. Se o runbook exigir parâmetros, eles serão listados no painel Parâmetros do Runbook. Selecione a coluna Valor para cada runbook e insira um valor para o runbook usar.

6. Se você quiser executar o runbook em um servidor diferente do padrão, selecione um servidor no painel Servidor(es) Runbook Disponível(is) e, em seguida, selecione a seta para a direita para adicionar o servidor ao painel Servidor(es) Runbook Selecionado(s).

   Observação

   Se você adicionar vários servidores ao painel Servidores Runbook Selecionados , o runbook será executado somente no primeiro servidor, se estiver disponível. Os outros servidores são servidores de backup em que o runbook é executado somente se o servidor primário não estiver disponível.

7. Selecione Iniciar.

Siga estas etapas para interromper um runbook:

1. Selecione Runbooks para abrir o workspace Runbooks.

2. Se o runbook estiver localizado em uma pasta, selecione a pasta no painel Runbooks .

3. Selecione a guia Runbooks no painel de resultados.

4. Selecione o runbook e, no painel Ações , selecione Parar Runbook.

5. Selecione OK para a mensagem para confirmar que você deseja interromper os trabalhos.

6. Se o runbook foi iniciado com êxito, você receberá uma mensagem de confirmação de que o trabalho foi parado. Se o runbook não tiver nenhum trabalho em execução, você receberá uma mensagem de que nenhum trabalho estava sendo executado.

Siga estas etapas para exibir o status de um runbook no console do Orchestration:

1. Selecione Runbooks para abrir o workspace Runbooks.

2. Se o runbook estiver localizado em uma pasta, selecione a pasta no painel Runbooks .

3. Selecione a guia Runbooks no painel de resultados.

4. Selecione o runbook.

5. Para exibir todos os trabalhos que o runbook criou, no painel Ações , selecione Exibir Trabalhos.

6. Para exibir todas as instâncias que o runbook criou, no painel Ações , selecione Exibir Instâncias.