Criar uma integração da ferramenta DevOps

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura
  • Para criar uma integração de ferramenta de DevOps, o desenvolvedor de integração configura DevOps configurações de integração de ferramenta e um subfluxo Workflow Studio para coletar e transformar dados da ferramenta de origem. Em seguida, o administrador DevOps configura as conexões da ferramenta DevOps.

    Antes de Iniciar

    Nota:
    Ao criar uma integração como um app com escopo, o administrador do sistema deve atribuir essas funções ao desenvolvedor de integração para que o desenvolvedor de integração possa criar registros de integração de ferramenta e capacidade de integração para o escopo específico.
    • Função de desenvolvedor para o app com escopo
    • DevOps função de administrador

    Função necessária: sn_devops.admin

    Por Que e Quando Desempenhar Esta Tarefa

    Criar um procedimento de integração da ferramenta DevOps envolve a configuração pelo desenvolvedor de integração e pelo administrador DevOps.
    • Seu desenvolvedor de integração cria um registro de integração de ferramenta em DevOps, um Workflow Studio subfluxo, um mapeamento de capacidade de ferramenta e um registro de capacidade de integração em DevOps para mapear as capacidades e as ações juntas.
      Nota:
      Recursos de notificação, conexão e descoberta são compatíveis.
    • Seu administrador DevOps configura conexões de DevOps (ferramenta de planejamento ou codificação) e configura a ferramenta de origem com o webhook e as credenciais.

    Este procedimento fornece etapas detalhadas para criar a integração da ferramenta DevOps.

    Procedimento

    1. Desenvolvedor de integrações:
      Configure as capacidades e ações de integração da ferramenta de origem e um subfluxo.
      1. Navegar até DevOps > Integrações > Integrações de Ferramentas e crie um registro para definir a ferramenta que você está integrando (ferramenta de origem).
        Nota:
        Não edite os registros de integração da ferramenta fornecidos com a aplicação DevOps.
        Tabela 1. Integração da ferramenta de DevOps
        Rótulo da ferramenta Ferramenta de código de amostra
        Tabela Ferramenta de código [sn_devops_tool]
        Usar integrações empacotáveis Selecionado
        Versão de integração 1.0
        Ativo Selecionado
      2. Navegar até Flow Designer > Designer e crie um subfluxo para coletar e transformar dados da ferramenta que você está integrando (ferramenta de origem).
        Nota:
        O campo Executar como deve ser definido como Usuário do sistema e o rótulo Entradas deve ser definido como a variável atual.
        Tabela 2. Propriedades do subfluxo de notificação
        Nome Notificação da ferramenta de código
        Aplicação App de integração de amostra
        Acessível de Todos os escopos de aplicação
        Descrição Ferramenta de código para app de integração
        Executar como Usuário do Sistema
        O subfluxo deve conter Obter mais dados por meio de chamadas de API e/ou transformar a carga original. Copie a carga transformada para o registro de eventos de entrada.
        Nota:
        Não edite o fluxo principal do DevOps.
      3. Navegar até DevOps > Integrações > Mapeamentos da capacidade da ferramenta e crie um registro para mapear o registro de integração da ferramenta para a capacidade do tipo de ferramenta.
        Tabela 3. DevOps mapeamento de capacidade da ferramenta
        Integração da ferramenta Ferramenta de amostra
        Capacidade do tipo de ferramenta Código
      4. Navegar até DevOps > Integrações > Capacidades de integração e crie um registro para especificar a ação para o mapeamento de capacidades da ferramenta.
        Nota:
        Não edite os registros de capacidade de integração fornecidos com a aplicação DevOps.
        Tabela 4. DevOps capacidade de integração
        Integração da ferramenta Ferramenta de código de amostra
        Mapeamento da capacidade

        Ferramenta de código de amostra - Código

        Nota:
        Não edite registros de capacidade do tipo de ferramenta.
        Ação

        Notificação

        Nota:
        Não edite registros de ação da ferramenta.
        Ativo Selecionado
        Tempos limites (ms)

        Tempo limite para o subfluxo correspondente. Se a execução do subfluxo exceder esse valor, ocorrerá uma exceção de tempo limite.

        O valor está em milissegundos (ms). O padrão é 45.000 (45 segundos).

        Nome do subfluxo

        x_snc_sample_integ.code_tool_notification

        O nome é prefixado pelo nome do escopo e um ponto (.) antes do nome do subfluxo real.

        Por exemplo, dado:
        • Subfluxoconnect_code_tool
        • escopomy_app_scope
        O valor deste campo é my_app_scope.connect_code_tool.
        Nota:
        Se o campo Nome do subfluxo for deixado em branco para uma capacidade de notificação, ocorrerá o processamento padrão de notificações.

        Consulte Ação da capacidade da ferramenta de notificação.

        Domínio global
    2. DevOps administrador:

      Configure a conexão de DevOps com a ferramenta de origem.

      1. O registro da ferramenta deve conter:
        • Referência ao registro de integração da ferramenta criado pelo desenvolvedor de integração (no campo Ferramenta )
        • Rótulo da ferramenta
        • Alias de conexão (conexão e credencial)
      2. Copie a notificação (webhook) criada na ferramenta de planejamento DevOps para o gancho de serviço da ferramenta de origem do endpoint de notificação e defina as credenciais como devops.integration.user.
      Você pode exibir o estado dos eventos de integração na lista de eventos de entrada (DevOps > Administração > Eventos de Entrada).

      O estado do registro de evento de entrada é definido como Processado quando o objeto é inserido na tabela DevOps Core. Os estados do evento incluem Novo, Em andamento, Processado, Incompatível e Erro.

    3. Se o registro de integração da ferramenta e o subfluxo forem criados em um escopo diferente, o administrador DevOps deverá criar dois novos registros de privilégios entre escopos para permitir que o app acesse a tabela de eventos de entrada.
      Navegar até Aplicações do sistema > Acesso entre escopos da aplicação e crie registros de privilégios entre escopos de leitura e gravação para permitir que seu app acesse a tabela de eventos de entrada.
      Campo Leitura Gravar
      Escopo de origem Preenchido automaticamente com base na aplicação atual
      Escopo de destino DevOps
      Nome de destino sn_devops_inbound_event
      Tipo de Destino Tabela
      Operação Leitura Gravar
      Status Permitido

    Exemplo

    Figura 1. DevOps integração da ferramenta
    DevOpsToolIntegration
    Figura 2. Workflow Studio propriedades de subfluxo
    SubflowProperties
    Figura 3. Workflow Studio subfluxo
    Subfluxo
    Figura 4. Workflow Studio DevOps Integração - Fluxo de notificação
    NotificationFlow
    Figura 5. DevOps mapeamento de capacidade da ferramenta
    Mapeamento de integração de usuário de DevOps
    Figura 6. Capacidade de integração
    IntegrationCapability
    Figura 7. Ferramenta de planejamento
    IntegrationPlanningTool
    Figura 8. Registros de acesso entre escopos (leitura e gravação)
    CrossScopeAccess