Macro de pendências do JIRA

マクロ

このページの内容

関連コンテンツ

  • 関連コンテンツがありません

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

Se o seu site Confluence estiver conectado a um aplicação JIRA, você pode criar e exibir pendências JIRA nas páginas do Confluente. Você pode conectar o Confluence a qualquer aplicação JIRA, incluindo JIRA Software e JIRA Service Desk. 

O que você pode fazer com a macro de pendências do JIRA

Ao utilizar a macro de pendências do JIRA, você pode:

  • Exibir uma lista de pendências na sua página, com base em uma Pesquisa, filtro ou URL de JQL (JIRA Query Language).
  • Exibir uma única pendência.
  • Exibe uma contagem de pendências.
  • Criar novas pendências e exibir as pendências na sua página sem sair do Confluence.

Incluindo e atualizando a macro de pendências do JIRA – uma visão geral

Guia rápido para usar a macro em uma página do Confluence:

  1. Confluence のエディタで、[挿入] > [その他のマクロ] を選択します。
  2. 対象のマクロを見つけて、選択します。

Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Autocomplete for links, files, macros, mentions and emojis.

既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。マクロのパラメータが編集可能な場合、マクロのダイアログ ウィンドウが開きます。

 

Captura de tela: Exemplo de macro de pendências do JIRA em uma página do Confluence


Exibindo pendências através de uma pesquisa em JQL (JIRA Query Language)

Você pode usar a macro para exibir uma tabela de pendências na sua página, com base nos resultados de uma Pesquisa utilizando JQL (JIRA Query Language).

JQL é uma linguagem de pesquisa similar à SQL. Uma pesquisa em JQL consiste em um campo, seguido por um operador (como = ou >), seguido por um ou mais valores ou funções.

Exemplos:

  • A pesquisa a seguir encontrará todas as pendências do projeto "TEST":

    projeto = "TEST"

  • A pesquisa a seguir encontrará todas as pendências no componente "documentação" do  projeto "CONF":

    projeto = CONF e componente = documentação

Para obter mais informações sobre a sintaxe JQL, consulte Pesquisa avançada a documentação JIRA Software.

Para exibir uma tabela de pendências baseada em uma pesquisa JQL:

  1. Insira a macro de pendências do JIRA na sua página do Confluence, conforme descrito acima.
  2. Escolha um servidor JIRA próximo ao botão de Pesquisa.
  3. Caso seja solicitado, faça o login no servidor JIRA.
  4. Insira a consulta JQL na caixa de Pesquisa.
  5. Escolha a Pesquisa.
  6. Caso você deseje personalizar a exibição, escolha Opções de exibição e ajuste as colunas e o número de pendências que aparecerão na sua tabela de pendências.
  7. Selecione Inserir.

Captura de tela: Exibir opções do navegador de macro de pendências do JIRA.

Exibir pendências por meio de um URL do JIRA

Você pode colar qualquer um dos URLs de aplicação JIRA na macro de pendências do JIRA. O Confluence converterá imediatamente o URL para uma pesquisa JQL.

  • Qualquer URL para uma pesquisa ou filtro de pendência.
  • Um URL para uma pendência isolada.
  • O URL de visualização em XML de uma pesquisa.

Converter automaticamente: É possível colar URLs diretamente no editor do Confluence (sem abrir o navegador de macro). O Confluence converterá automaticamente o URL em uma macro de pendências do JIRA.

Exibir uma única pendência ou pendências selecionadas

Para exibir uma única pendência do JIRA, escolha um dos métodos a seguir:

  • Cole o URL da pendência diretamente na página do Confluence. (Não há necessidade de usar o navegador de macro.) O Confluence converterá automaticamente o link em uma macro de pendências do JIRA.
  • Ou: Adicione a macro de pendências do JIRA à página conforme descrito acima e escolha Visualizados recentemente para ver as pendências que você visitou recentemente. Selecione uma pendência e escolha Inserir.
  • Ou: Adicione a macro de pendências do JIRA à página conforme descrito acima e cole o URL da pendência na caixa de pesquisa no navegador de macro.
  • Ou: Adicione a macro de pendências do JIRA à página, defina os critérios da sua pesquisa no navegador de macro via JQL, conforme descrito acima e, em seguida, marque a caixa ao lado da pendência nos resultados da pesquisa, dentro do navegador de macro.

É possível escolher mostrar apenas a chave da pendência ou a chave da pendência e um resumo. Selecione o espaço reservado da macro e escolha mostrar resumo ou ocultar resumo. 

Para exibir um subconjunto de pendências do JIRA nos resultados da sua pesquisa:

  1. Adicione a macro de pendências do JIRA à página.
  2. Defina seus critérios de pesquisa no navegador de macro via JQL, conforme descrito acima.
  3. Marque as caixas ao lado das pendências necessárias nos resultados da pesquisa dentro do navegador de macro.

Captura de tela: Selecionar um subconjunto de pendências a exibir

Exibindo uma contagem de pendências

É possível escolher exibir o número de pendências retornadas pela sua pesquisa, em vez de uma tabela de pendências. A macro de pendências do JIRA mostrará uma contagem de pendências com link para a pesquisa na sua aplicação JIRA.

Captura de tela: A macro de pendências do JIRA exibindo uma contagem de pendências em um página do Confluence

Para exibir uma contagem de pendências:

  1. Adicione a macro de pendências do JIRA à página.
  2. Defina seus critérios de pesquisa no navegador de macro via JQL, conforme descrito acima.
  3. Escolha Opções de exibição e, em seguida, Contagem total de pendências ao lado de "Opções de exibição" no navegador de macro.
  4. Selecione Inserir.

Criar uma nova pendência 

Ao editar uma página do Confluence, é possível criar uma pendência no JIRA e exibi-la em sua página do Confluence sem sair do editor do Confluence.

Para criar uma pendência e adicioná-la à sua página:

  1. Adicione a macro de pendências do JIRA à página, conforme descrito acima.
  2. Escolha Criar nova pendência.
  3. Forneça as informações de seu servidor JIRA, projeto e pendência, conforme pedido.
  4. Selecione Inserir.

O Confluence enviará uma solicitação à sua aplicação JIRA para criar a pendência e, em seguida, exibir a pendência recém-criada em sua página.

Limitações

A macro de pendências do JIRA notificará você se não for possível criar uma pendência no projeto selecionado. Isso pode acontecer porque o projeto tem um campo obrigatório, uma configuração de campo ou outra personalização que não tem suporte pela macro de pendências do JIRA. Nessa situação, será necessário criar a pendência diretamente em sua aplicação JIRA.

Renderizar HTML pelas aplicações JIRA

Campos formatados do JIRA podem ser exibidos no Confluence se você configurar um link de aplicação Confluence para JIRA. Do contrário, esses campos formatados serão excluídos dentro do resultado da macro de pendências do JIRA. Isso ocorre para evitar a possibilidade de HTML malicioso ser fornecido por um servidor JIRA que não seja de confiança. A maior probabilidade de se perceber isso é no campo descrição.

Esse exemplo mostra como uma coluna de descrição pode ser exibida no JIRA:

Descrição

Esta é

  • a descrição
  • da minha pendência

Se não houver nenhum link de aplicação entre JIRA e Confluence, a descrição aparecerá na macro de pendências do JIRA da seguinte maneira:

Descrição

<p>Esta é<ul><li>a descrição</li><li>da minha pendência</li></ul></p>

Desativar a macro de pendências do JIRA

A funcionalidade é fornecida por um complemento (plugin) chamado "JIRA Macros". Para tornar a macro indisponível em seu site, é possível desativar o complemento. Consulte Desativando e ativando complementos.

Exemplo de marcação do wiki

Esse exemplo é útil quando você quer adicionar uma macro fora do editor, por exemplo, como um conteúdo personalizado na barra lateral, no cabeçalho ou no rodapé de um espaço.

Nome da macro: jiraissues

Corpo da macro: Nenhum.

Esse exemplo usa um filtro JIRA. 

{jiraissues:anonymous=true|url=https://jira.atlassian.com/issues/?filter=41225}

Diversos parâmetros adicionais que não estão disponíveis via navegador de macro estão disponíveis em formato de armazenamento e marcação do wiki.

Consulte os parâmetros adicionais...

Nome do parâmetro

Obrigatório

Padrão

Descrição do parâmetro e valores aceitos

anonymous

いいえ

false

Se esse parâmetro for configurado como "true", sua aplicação JIRA retornará apenas as pendências que permitirem visualização irrestrita. Ou seja, as pendências que são visíveis a visualizadores anônimos. Se esse parâmetro for omitido ou configurado como "false", os resultados dependerão de como seu administrador configurou a comunicação entre a aplicação JIRA e o Confluence. Por padrão, o Confluence mostrará apenas as pendências que o usuário tem autorização para visualizar.

Nota: Este parâmetro fica disponível somente se a macro for inserida via marcação do wiki ou por meio de edição do formato de armazenamento da página. O navegador de macro não oferece esse parâmetro.

baseurl

いいえ

O valor do parâmetro "url"

Se for especificado um "baseurl", o link no cabeçalho, que indica a sua aplicação JIRA, usará esse URL base em vez do valor do parâmetro "url". Isso é útil quando o Confluence se conecta ao JIRA com um URL diferente do usado pelos outros usuários.

columns

いいえ

Por padrão, as seguintes colunas são mostradas:

  • tipo
  • chave
  • resumo
  • responsável
  • relator
  • prioridade
  • ステータス
  • resolução
  • criação
  • atualização
  • prazo

Uma lista de nomes de coluna do JIRA, separados por ponto e vírgula (;). É possível incluir muitas colunas reconhecidas pela sua aplicação JIRA, incluindo colunas personalizadas.

Algumas colunas, como as que precisam ser calculadas pelo JIRA, como "work ratio" (proporção de trabalho) ou "time to resolution" (tempo para solução), não podem ser visualizadas no Confluence.

count

いいえ

false

Se esse parâmetro for configurado como "true", a lista de pendências mostrará o número de pendências no JIRA. A contagem será ligada ao seu site JIRA.

cache

いいえ

on

A macro mantém um cache de pendências que resultam da consulta do JIRA. Se o parâmetro "cache" for definido como "off", a parte relevante do cache é esvaziada toda vez que a macro é recarregada. (O valor "false" também funciona e tem o mesmo efeito de "off".)

Nota: Este parâmetro fica disponível somente se a macro for inserida via marcação do wiki ou por meio de edição do formato de armazenamento da página. O navegador de macro não oferece esse parâmetro.

height

いいえ

480 (se o modo de renderização for dinâmico)

A altura em pixels da tabela exibindo as pendências.
Observe que essa especificação de altura é ignorada nas seguintes situações:

  • Se o parâmetro "renderMode" (consulte abaixo) for configurado como "static".
  • Quando as pendências são exibidas em um documento de PDF ou de Word, insira uma mensagem de e-mail ou RSS feeds.

Nota: Este parâmetro fica disponível somente se a macro for inserida via marcação do wiki ou por meio de edição do formato de armazenamento da página. O navegador de macro não oferece esse parâmetro.

renderMode

いいえ

static

Se o valor for "dynamic", a macro de pendências do JIRA fornecerá uma tela interativa que pode ser manipulada da seguinte forma:

  • Clique nos cabeçalhos das colunas para classificar a saída.
  • Arraste e solte as colunas em uma ordem diferente.
  • Remova temporariamente a coluna da exibição.
  • Exiba uma página de pendências de cada vez para tempos de resposta mais rápidos.

Um valor "static" desabilitará os recursos da exibição dinâmica.

Nota: Este parâmetro fica disponível somente se a macro for inserida via marcação do wiki ou por meio de edição do formato de armazenamento da página. O navegador de macro não oferece esse parâmetro.

title

いいえ

Pendências do JIRA

Com esse parâmetro é possível personalizar o texto do título na parte superior da tabela das pendências. Por exemplo, configurar o título para "Bugs-para-corrigir" substituirá o texto padrão "Pendências do JIRA". Isso pode ajudar a fornecer mais contexto para a lista de pendências exibida.

Nota: Este parâmetro fica disponível somente se a macro for inserida via marcação do wiki ou por meio de edição do formato de armazenamento da página. O navegador de macro não oferece esse parâmetro.

url

はい

なし

O URL de visualização do XML das pendências selecionadas.

Nota: Se o URL do parâmetro "url" não contém um argumento tempMax então, o valor de tempMax terá como padrão 500. Se a versão do servidor do JIRA for 3.12 ou anterior, isso significa que a macro de pendências do JIRA retornará um máximo de 500 pendências. Se a versão do servidor do JIRA for 3.13 ou posterior, um valor de 500 significa que a macro de pendências do JIRA retornará um máximo de 500 pendências por página.

width

いいえ

100%

A largura da tabela exibindo as pendências. Pode ser inserida em porcentagem (%) ou em pixels (px).

Nota: Este parâmetro fica disponível somente se a macro for inserida via marcação do wiki ou por meio de edição do formato de armazenamento da página. O navegador de macro não oferece esse parâmetro.

最終更新日 2017 年 8 月 7 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する

関連コンテンツ

  • 関連コンテンツがありません
Powered by Confluence and Scroll Viewport.