Configuração avançada do fluxo de trabalho
Esta página descreve a configuração das transições nos fluxos de trabalho no JIRA. Para obter informações sobre os fundamentos de fluxo de trabalho, consulte Trabalhar com fluxos de trabalho.
Como um administrador do JIRA, você pode controlar os seguintes aspectos do comportamento de uma transição:
- Acionadores – transição de pendências do JIRA quando determinados eventos ocorrem em uma ferramenta de desenvolvimento conectada, como Bitbucket ou Stash da Atlassian.
- Condições – verifique se uma transição deve ser feita pelo usuário.
- Validadores – verifique se qualquer entrada à transição (por exemplo, por um usuário) é válida antes que a transição seja realizada.
- Pós-funções – realizar um processamento adicional depois que uma transição é realizada.
- Propriedades – são os pares de chave-valor que podem ser usados para personalizar melhor as transições.
Também nesta página:
Acionadores
Os administradores do JIRA podem configurar acionadores em fluxos de trabalho do JIRA que respondem a eventos nas ferramentas de desenvolvimento vinculadas. Isso permite configurar as ferramentas de desenvolvimento e os fluxos de trabalho do JIRA de modo que, por exemplo, quando um desenvolvedor cria um branch para começar a trabalhar em uma pendência no Bitbucket ou no Stash do Atlassian, a pendência fará automaticamente a transição de "Aberto" para "Em andamento".
Se você não tiver configurado um acionador antes ou desejar saber mais detalhes sobre acionadores, consulte nosso guia sobre acionadores aqui: Configurar acionadores de fluxo de trabalho. O guia também mostra como configurar um fluxo de trabalho com acionadores, de modo similar a este exemplo de fluxo de trabalho de desenvolvimento: Fluxo de trabalho de desenvolvimento com acionadores (do Atlassian Marketplace).
Configurar acionadores
Para ver ou definir acionadores para uma transição, edite o fluxo de trabalho que contém a transição, selecione a transição e então clique em Acionadores no painel de propriedades para a transição.
Condições
Condições controlam se uma transição deve ser executada pelo usuário. Por exemplo, as condições podem ser usadas para:
- permitir que o relator execute uma transição;
- permitir que somente usuários com uma determinada permissão executem uma transição;
- permitir a execução somente se um código tiver, ou não tiver, sido confirmado com relação à pendência.
Se uma condição falhar, o usuário não verá o botão de transição na página "Visualizar pendência" e, portanto, não poderá executar a transição.
As condições não podem validar os parâmetros de entrada reunidos do usuário na tela de transição , você precisa de um validador para fazer isso.
As seções a seguir descrevem:
Adicionar uma condição
Para adicionar uma condição a uma transição, edite o fluxo de trabalho que contém a transição, selecione a transição e então clique em Condições no painel de propriedades para a transição.
Na guia Condições, você pode ver quaisquer condições já definidas.
Ao clicar em Adicionar condição, você pode escolher entre as condições disponíveis e definir quaisquer parâmetros necessários para a condição. Condições adicionais também podem estar disponíveis nos plugins instalados, ou você pode criar suas próprias condições usando o sistema de plugin; consulte detalhes nos módulos do plugin de fluxo de trabalho.
Observe que você também pode editar a transição no modo "texto".
Agrupar condições
É possível criar condições complexas agrupando e aninhando condições. Altere qualquer condição em um grupo clicando no ícone "Adicionar condição agrupada" para a condição. Agora você pode adicionar mais condições a esse novo grupo, conforme descrito acima.
É possível alternar a lógica de como as condições em um grupo são aplicadas entre Todos e Qualquer um.
Validadores
Os validadores verificam se qualquer entrada feita para a transição é válida antes de a transição ser executada. A entrada pode incluir o que foi coletado do usuário na tela da transição.
Se um validador falhar, a pendência não avançará para o status de destino da transição, e as funções posteriores da transição não serão executadas.
Adicionar um validador
Para adicionar um validador a uma transição, edite o fluxo de trabalho que contém a transição, selecione a transição e então clique em Validadores no painel de propriedades para a transição.
Na guia Validadores, você pode ver quaisquer validadores já definidos.
Ao clicar em Adicionar validador, você pode escolher entre os validadores disponíveis e definir quaisquer parâmetros necessários para o validador.
Observe que você também pode editar a transição no modo "texto".
Funções posteriores
Funções posteriores realizam qualquer processamento adicional necessário depois que a transição é executada, por exemplo:
- atualizar os campos de uma pendência
- gerar um histórico de alterações para uma pendência
- adicionar um comentário a uma pendência
- gerar um evento para acionar notificações por e-mail
As seções a seguir descrevem:
Funções posteriores essenciais
Cada transição do JIRA tem as seguintes funções posteriores essenciais, as quais são executadas nesta ordem:
- Definir o status da pendência para o status vinculado do status do fluxo de trabalho de destino.
- Adicionar um comentário a uma pendência, caso seja inserida uma durante uma transição.
- Atualizar o histórico de alterações para uma pendência e armazenar a pendência no banco de dados.
- Reindexar uma pendência para manter os índices sincronizados com o banco de dados.
- Disparar um evento que possa ser processado pelos ouvintes.
Essas funções posteriores essenciais não podem ser excluídas de uma transição nem reordenadas. Porém, você pode inserir outras funções posteriores (opcionais) entre elas.
Funções posteriores opcionais
O JIRA inclui várias funções posteriores opcionais que podem ser adicionadas a transições.
Função posterior opcional | Descrição |
|---|---|
Atribuir ao usuário atual | Atribua a pendência ao usuário que está executando a transição. |
Atribuir ao desenvolvedor líder | Atribui a pendência ao líder do componente, se houver um, ou ao líder do projeto. |
Atribuir ao relator | Atribui a pendência ao usuário que a criou. |
Cria uma função de trabalho do Perforce | Cria um trabalho do Perforce (se necessário) após concluir a transição do fluxo de trabalho. |
| Notificar HipChat | Envia uma notificação a uma ou mais salas do HipChat. Consulte Usar uma função posterior para enviar notificações do HipChat para obter mais informações. |
| Acionar um webhook | Aciona o webhook especificado depois que a transição do fluxo de trabalho é concluída. Ao adicionar essa função posterior, você poderá ser solicitado a especificar um webhook. Esse webhook já deve ter sido definido no JIRA (consulte Gerenciar webhooks). |
Atualizar campos da pendência | Atualiza um dos campos da pendência para um determinado valor. Os campos que podem ser atualizados incluem:
|
Funções posteriores adicionais podem estar disponíveis nos plugins instalados, ou você pode criar suas próprias funções posteriores usando o sistema de plugin; consulte detalhes nos módulos do plugin de fluxo de trabalho.
Adicionar uma função posterior
Para adicionar uma função posterior a uma transição, edite o fluxo de trabalho que contém a transição, selecione a transição e depois clique em Funções posterioresno painel de propriedades da transição.
Na guia Funções posteriores, você pode ver quaisquer funções posteriores já definidas. Ao clicar em Adicionar função posterior, você pode escolher entre as funções posteriores disponíveis e definir quaisquer parâmetros necessários. As opções para editar ou excluir uma função posterior e para alterar a ordem de execução estão à direita da guia (passe o cursor do mouse para visualizá-las).
Observe que você também pode editar a transição no modo "texto".
Usar funções posteriores com a transição inicial
Você pode adicionar funções posteriores à transição inicial de um fluxo de trabalho quando precisar realizar tarefas de processamento (como definir o valor de um campo em particular) quando uma pendência for criada. A transição inicial chama-se "Criar" (se você tiver criado um fluxo de trabalho em branco), ou "Criar pendência" (se você tiver copiado o fluxo de trabalho do sistema).
O JIRA inclui as seguintes funções posteriores essenciais específicas para a transição inicial de um fluxo de trabalho e executadas nesta ordem:
- Criar a pendência.
- Disparar um evento que possa ser processado pelos ouvintes.
As seguintes funções posteriores opcionais estão disponíveis especificamente para a transição inicial:
Função posterior opcional (somente transição inicial) | Descrição |
|---|---|
Criar comentário | Adiciona um comentário a uma pendência, caso seja inserida uma durante uma transição. |
Atualizar status da pendência | Define o status da pendência para o status vinculado do status do fluxo de trabalho de destino. |
Armazenar pendência | Armazena atualizações em uma pendência (nenhum histórico de alterações é criado). |
Além disso, as funções posteriores opcionais padrão também podem ser adicionadas a uma transição inicial.
Funções posteriores opcionais adicionadas à transição Criar devem ser colocadas antes da função posterior "Criar a pendência originalmente".
Se desejar, pode configurar o status inicial para seu fluxo de trabalho ir para uma transição inicial diferente. Consulte detalhes em Configurar o status inicial.
Notas
Se precisar definir o campo "Resolução" ao criar uma pendência, adicione a função posterior "Atualizar campo da pendência" depois da função posterior "Criar a pendência" e depois disso, use a função posterior "Armazenar pendência". A função posterior "Armazenar pendência" é útil para configurar o campo Resolução durante a criação da pendência.
Porém, use a função posterior Armazenar pendência somente quando necessário, já que ela:
- não gera histórico de alterações
- não consegue manter campos que tenham relacionamento de um para muitos com a pendência (por exemplo, "Versão" ou "Componente")
Usar uma função posterior para definir um campo
Você pode usar a função posterior "Atualizar campos da pendência" para definir o valor do campo de uma pendência após uma transição em particular ser executada.
Por exemplo, você pode desejar ter uma transição que mova a pendência para um status fechado com o fim de definir automaticamente o campo "Resolução".
Exemplo: Usar uma função posterior para definir o campo Resolução:
Edite o fluxo de trabalho que tem a transição e arraste-o de um status para outro a fim de criar uma nova transição.
- Selecione Nenhum ou uma tela que não contenha o campo Resolução:
- Adicione uma nova função posterior do tipo "Atualizar campo da pendência" e:
- Selecione Resolução na lista Campo de pendência.
- Selecione uma resolução adequada na lista Valor do campo.
Para criar uma transição que limpe o campo Resolução, siga a mesma etapa acima para adicionar uma função posterior "Atualizar campos da pendência" à sua transição. Porém, selecione Nenhum na lista Valor do campo.
A lista de funções posteriores para essa transição inclui a seguinte declaração:
- A Resolução da pendência será limpa.
Sempre que uma dessas transições é executada, a Resolução da pendência é automaticamente definida ou limpa, conforme especificado nessas funções posteriores.
Usar uma função posterior para enviar notificações do HipChat
Você pode usar uma função posterior "Notificar HipChat" para enviar uma notificação a uma ou mais salas do HipChat sempre que uma pendência passar por uma transição com essa função posterior. Você também pode adicionar uma consulta JQL à função "Notificar Hipchat" para filtrar as pendências que acionarão a notificação do HipChat.
Para enviar notificações do HipChat:
- Crie ou edite sua transição.
- Adicione uma nova função posterior do tipo "Notificar HipChat",
- na página "Adicionar parâmetros para a função":
- Opcionalmente, especifique uma consulta JQL. Somente pendências que correspondam à consulta enviarão notificações.
Deixe esse campo vazio para enviar notificações a todas as pendências que passam por essa transição. - Selecione as salas do HipChat que gostaria de vincular à sua transição de fluxo de trabalho.
- Opcionalmente, especifique uma consulta JQL. Somente pendências que correspondam à consulta enviarão notificações.
Usar uma função posterior para enviar notificações por e-mail
Use a função posterior "Acionar um evento que possa ser processado pelos ouvintes" para acionar o "Evento genérico", que é um Evento do JIRA integrado que pode ser usado para acionar o envio de notificações por e-mail após a execução de uma transição em particular.
Como alternativa, é possível acionar um evento personalizado criado especificamente para essa transição.
Quando a transição for realizada, o JIRA:
- consultará o esquema de notificação associado ao projeto da pendência e à identidade dos usuários associados ao evento acionado;
- enviará uma notificação por e-mail a cada usuário.
O evento acionado também é propagado a todos os ouvintes registrados.
Exemplo: Usando uma função posterior para acionar o evento genérico para enviar notificações por e-mail:
- Crie ou edite sua transição.
- Clique na guia Função posterior da transição e edite a função posterior "Acionar um evento que possa ser processado pelos ouvintes".
Selecione Evento genérico na lista de eventos.
Propriedades da transição
As propriedades são pares de chave e valor que podem ser usados para personalizar ainda mais as transições. Por exemplo, propriedades de transição podem ajudá-lo a estender um fluxo de trabalho do sistema copiado para permitir traduções de idiomas.
Para visualizar e editar as propriedades de uma transição:
- Selecione uma transição no diagrama.
- Clique em Propriedades no painel Propriedades.
- Execute uma destas opções:
- Adicionar uma nova propriedade à transição.
- Excluir uma propriedade clicando no ícone à direita da propriedade.
Importante
Não é possível editar as propriedades de uma transição nessa página. Para alterar a chave ou o valor (ou ambos) de qualquer propriedade, primeiro exclua a propriedade que deseja alterar e adicione a nova propriedade atualizada.
Observe que você também pode editar a transição no modo "texto".
É possível implementar restrições a transições usando propriedades de transição. Para obter mais informações, consulte Propriedades de fluxo de trabalho.
Personalizar o modo como as transições aparecem
Ao visualizar uma pendência, a maioria das operações e transições de fluxo de trabalho estão disponíveis em uma linha de botões na parte superior da pendência.
Para alterar o número padrão de dois botões de transição:
Por padrão, as duas primeiras transições aparecem como botões separados no conjunto de botões de transição. Transições adicionais aparecem no menu Fluxo de trabalho. A ordem em que esses botões aparecem baseia-se na ordem definida no fluxo de trabalho do sistema.
- Desligue o JIRA.
- Edite o arquivo
jira-config.propertiesno seu Diretório inicial da aplicação JIRA . Consulte Realizar alterações no arquivojira-config.propertiespara obter mais informações. - Altere o valor de "
X" na propriedadeops.bar.group.size.opsbar-transitions = Xdesse arquivo para que seja o número de botões de transição exigidos antes do menu Fluxo de trabalho.
Se essa propriedade não existir no seu arquivo jira-config.properties, adicione-a. Caso contrário, um valor padrão de 2 será presumido. - Salve o arquivo
jira-config.propertiesatualizado. - Reinicie o JIRA.
Para alterar a ordem dos botões de transição:
Para alterar a ordem dos botões de transição, incluindo transições adicionais no menu Fluxo de trabalho, adicione a chave de propriedade opsbar-sequence a cada transição do fluxo de trabalho que você deseje reordenar. Cada chave de propriedade opsbar-sequence requer um valor de propriedade que defina a ordem da ação de transição em visualizações de pendência.
- Acesse as propriedades da transição, conforme descrito em Propriedades da transição acima.
- Digite
opsbar-sequenceno campo Chave da propriedade em "Adicionar nova propriedade". - Digite um valor no campo Valor da propriedade. O valor deve ser um inteiro positivo (começando em "0"); ele define a ordem dos botões de transição em visualizações de pendência.
Considere usar uma sequência de valores de propriedadeopsbar-sequencecomo 10, 20, 30… para permitir que novas transições sejam facilmente adicionadas mais tarde. - Clique em Adicionar.
Adicionar a propriedade opsbar-sequence a uma transição de fluxo de trabalho não muda a ordem dessas transições no fluxo de trabalho no modo de edição de Texto. A adição dessa propriedade afeta apenas a ordem das transições na página Visualizar pendência.
Transições globais
As transições globais permitem que qualquer status em um fluxo de trabalho faça a transição para um status em particular.
Você pode adicionar uma transição global:
- Ao criar um novo status (adicionar um status existente) – marque a opção Adicionar transição global ao status.
- Ao selecionar um status e marcar Permitir que todos os status façam a transição para este no painel de propriedades para o status.
Para criar duas transições globais que apontem para a mesma etapa de destino:
- No designer de fluxo de trabalho, crie a primeira transição global da maneira usual selecionando uma etapa e marcando "Permitir que todos os status façam a transição para este"
- Crie a segunda transição global em qualquer outra etapa que não tenha uma transição global apontando para ela no momento
- Então, no editor de texto, selecione a segunda transição global criada
- Clique no botão "Editar" e altere a "Etapa de destino" para a mesma etapa selecionada na primeira transição global e, em seguida, clique em "Atualizar"