Criação de modelos de fluxo de trabalho

ATENÇÃO

Para usar a interface clássica, consulte a documentação do AEM 6.3 para referência.

Você cria um modelo de fluxo de trabalho para definir a série de etapas executadas quando um usuário inicia o fluxo de trabalho. Você também pode definir propriedades de modelo, como se o fluxo de trabalho é transitório ou usa vários recursos.

Quando um usuário inicia um workflow, uma instância é iniciada; esse é o modelo de tempo de execução correspondente, criado ao Sincronizar suas alterações.

Criação de um novo workflow

Ao criar um novo modelo de fluxo de trabalho pela primeira vez, ele contém:

  • As etapas, Início do fluxo e Fim do fluxo.
    Elas representam o início e o fim do workflow. Essas etapas são obrigatórias e não podem ser editadas/removidas.
  • Um exemplo da etapa Participante chamada Etapa 1.
    Essa etapa é configurada para atribuir um item de trabalho ao iniciador do fluxo de trabalho. Edite ou exclua esta etapa e adicione as etapas conforme necessário.

Para criar um novo workflow com o editor:

  1. Abra o console Modelos de fluxo de trabalho; por meio de Ferramentas, Fluxo de trabalho, Modelos ou, por exemplo: https://localhost:4502/aem/workflow
  2. Selecione Criar e Criar Modelo.
  3. A caixa de diálogo Adicionar modelo de fluxo de trabalho é exibida. Insira o Título e Nome (opcional) antes de selecionar Concluído.
  4. O novo modelo é listado no console Modelos de fluxo de trabalho.
  5. Selecione seu novo workflow e use Edit para abri-lo para configuração:
    wf-01
OBSERVAÇÃO

Se estiver criando modelos programaticamente (usando um pacote crx), você também poderá criar uma subpasta em:

/var/workflow/models

Por exemplo, /var/workflow/models/prototypes

Essa pasta pode ser usada para gerenciar o acesso aos modelos nessa pasta.

Editar um fluxo de trabalho

Você pode editar qualquer modelo de fluxo de trabalho existente para:

A edição de um workflow Padrão e/ou Herdado (pronto para uso) tem uma etapa adicional, para garantir que uma cópia segura seja realizada antes que suas alterações sejam feitas.

Quando as atualizações do seu fluxo de trabalho forem concluídas, você deverá usar Sync para Gerar um Modelo de Tempo de Execução. Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

Sincronizar o fluxo de trabalho - Gerar um modelo de tempo de execução

Sync (à direita na barra de ferramentas do editor) gera um modelo de tempo de execução. O modelo de tempo de execução é o modelo realmente usado quando um usuário inicia um fluxo de trabalho. Se você não Sincronizar suas alterações, as alterações não estarão disponíveis no tempo de execução.

Quando você (ou qualquer outro usuário) faz alterações no fluxo de trabalho, é necessário usar Sync para gerar um modelo de tempo de execução - mesmo quando caixas de diálogo individuais (por exemplo, para etapas) têm suas próprias opções de salvamento.

Quando as alterações são sincronizadas com o modelo de tempo de execução (salvo), Synched é exibido.

Algumas etapas têm campos obrigatórios e/ou validação incorporada. Quando essas condições não forem atendidas, um erro será mostrado quando você tentar Sincronizar o modelo. Por exemplo, quando nenhum participante foi definido para uma etapa Participante:

wf-21

Editar um fluxo de trabalho padrão ou herdado pela primeira vez

Ao abrir um Modelo padrão e/ou herdado para edição:

  • O navegador Etapas não está disponível (lado esquerdo).
  • Há uma ação Edit disponível na barra de ferramentas (lado direito).
  • Inicialmente, o modelo e suas propriedades são apresentados no modo somente leitura como:
    • Os workflows padrão estão localizados em /libs
    • Os workflows herdados estão localizados em /etc
      Selecionar
      ​A edição:
  • faça uma cópia do fluxo de trabalho em /conf
  • disponibilizar o navegador de etapas
  • permitir que você faça alterações
OBSERVAÇÃO

Consulte Locais de modelos de fluxo de trabalho para obter mais informações.

wf-22

Adicionar uma etapa a um modelo

Será necessário adicionar etapas ao modelo para representar a atividade a ser executada - cada etapa executa uma atividade específica. Uma seleção de componentes de etapa está disponível em uma instância de AEM padrão.

Ao editar um modelo, as etapas disponíveis são exibidas nos vários grupos do Navegador de etapas. Por exemplo:

wf-10

OBSERVAÇÃO

Para obter informações sobre os componentes da etapa principal instalados com o AEM, consulte Referência de etapas do fluxo de trabalho.

Para adicionar etapas ao modelo de fluxo de trabalho:

  1. Abra um modelo de fluxo de trabalho existente para edição. No console Modelo de fluxos de trabalho, selecione o modelo necessário e, em seguida, Editar.

  2. Abra o navegador Etapas ; usando Alternar painel lateral, na extremidade esquerda da barra de ferramentas superior. Aqui você pode:

    • ​Filtro para etapas específicas.
    • Use o seletor suspenso para limitar a seleção a um grupo específico de etapas.
    • Selecione o ícone Mostrar descrição wf-step-info-icon para mostrar mais detalhes sobre a etapa apropriada.

    wf-02

  3. Arraste as etapas apropriadas para o local desejado no modelo.

    Por exemplo, uma Etapa do participante.

    Depois de adicionado ao fluxo, você pode configurar a etapa.

    wf-03

  4. Adicione quantas etapas ou outras atualizações forem necessárias.

    Em tempo de execução, as etapas são executadas na ordem em que aparecem no modelo. Depois de adicionar componentes da etapa, você pode arrastá-los para um local diferente no modelo.

    Também é possível copiar, recortar, colar, agrupar ou excluir etapas existentes; como no editor de página.

    As etapas divididas também podem ser recolhidas/expandidas usando a opção da barra de ferramentas: wf-collapseexpand-toolbar-icon

  5. Confirme as alterações com Sync (barra de ferramentas do editor) para gerar o modelo de tempo de execução.

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

Configuração de uma etapa do fluxo de trabalho

Você pode Configurar e personalizar o comportamento de uma etapa de fluxo de trabalho usando as caixas de diálogo Propriedades da etapa.

  1. Para abrir a caixa de diálogo Propriedades da etapa para uma etapa, faça o seguinte:

    • Clique/toque na etapa no modelo de fluxo de trabalho e selecione Configurar** na barra de ferramentas do componente.

    • Clique duas vezes na etapa .

    OBSERVAÇÃO

    Para obter informações sobre os componentes da etapa principal instalados com o AEM, consulte Referência de etapas do fluxo de trabalho.

  2. Configure as Propriedades da etapa conforme necessário; as propriedades disponíveis dependem do tipo de etapa, também pode haver várias guias disponíveis. Por exemplo, o padrão Etapa do participante, presente em um novo workflow como Step 1:

    wf-11

  3. Confirme suas atualizações com a marca de verificação.

  4. Confirme as alterações com Sync (barra de ferramentas do editor) para gerar o modelo de tempo de execução.

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

Criação de um fluxo de trabalho transitório

Você pode criar um modelo de fluxo de trabalho Transitório ao criar um novo modelo ou editar um modelo existente:

  1. Abra o modelo de fluxo de trabalho para editing.

  2. Selecione Propriedades do modelo de fluxo de trabalho na barra de ferramentas.

  3. Na caixa de diálogo, ative Transient Workflow (ou desative se necessário):

    wf-07

  4. Confirme a alteração com Salvar e fechar; seguido por Sync (barra de ferramentas do editor) para gerar o modelo de tempo de execução.

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

OBSERVAÇÃO

Quando você executa um workflow no modo transient AEM não armazena nenhum histórico de workflow. Portanto, A Linha do tempo não exibe nenhuma informação relacionada a esse fluxo de trabalho.

Disponibilizar modelos de fluxo de trabalho na interface do usuário de toque

Se um modelo de fluxo de trabalho estiver presente na interface clássica, mas estiver ausente no menu pop-up de seleção no painel Linha do tempo da interface de toque, siga a configuração para disponibilizá-lo. As etapas a seguir ilustram o uso do modelo de fluxo de trabalho chamado Solicitação de ativação.

  1. Confirme se o modelo não está disponível na interface habilitada para toque. Acesse um ativo usando o caminho /assets.html/content/dam. Selecione um ativo. Abra Linha do tempo no painel esquerdo. Clique em Iniciar fluxo de trabalho e confirme se o modelo Solicitação de ativação não está presente na lista pop-up.

  2. Navegue por Ferramentas > Geral > Marcação. Selecione Workflow.

  3. Selecione Criar > Criar tag. Defina Title como DAM e Name como dam. Selecione Enviar.
    Criar tag no modelo de fluxo de trabalho

  4. Navegue até Ferramentas > Fluxo de trabalho > Modelos. Selecione Solicitação de ativação e selecione Editar.

  5. Selecione Editar, abra o menu Informações da página e, a partir daí, selecione Abrir propriedades e vá para a guia Básico (se ainda não estiver aberta).

  6. Adicione Workflow : DAM ao campo Tags. Confirme a seleção com a verificação (marca de verificação).

  7. Confirme a adição da tag com Salvar e fechar.
    Editar as propriedades da página do modelo

  8. Complete o processo com Sync. O fluxo de trabalho agora está disponível na interface habilitada para toque.

Configurar um fluxo de trabalho para suporte a vários recursos

Você pode configurar um modelo de fluxo de trabalho para Suporte a vários recursos ao criar um novo modelo ou editar um modelo existente:

  1. Abra o modelo de fluxo de trabalho para editing.

  2. Selecione Propriedades do modelo de fluxo de trabalho na barra de ferramentas.

  3. Na caixa de diálogo, ative Suporte a vários recursos (ou desative se necessário):

    wf-08

  4. Confirme a alteração com Salvar e fechar; seguido por Sync (barra de ferramentas do editor) para gerar o modelo de tempo de execução.

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

Configurando Estágios do Fluxo de Trabalho (que mostram o Progresso do Fluxo de Trabalho)

As Etapas do fluxo de trabalho visualizam o progresso de um fluxo de trabalho ao manipular tarefas.

ATENÇÃO

Se os estágios do fluxo de trabalho forem definidos em Propriedades da página, mas não forem usados para nenhuma das etapas do fluxo de trabalho, a barra de progresso não mostrará nenhum progresso (independentemente da etapa do fluxo de trabalho atual).

Os estágios a serem disponibilizados são definidos nos modelos de fluxo de trabalho; os modelos de fluxo de trabalho existentes podem ser atualizados para incluir definições de estágio. Você pode definir qualquer número de estágios para o modelo de workflow.

Para definir Estágios para o seu fluxo de trabalho:

  1. Abra o modelo de fluxo de trabalho para edição.

  2. Selecione Propriedades do modelo de fluxo de trabalho na barra de ferramentas. Em seguida, abra a guia Stages.

  3. Adicione (e posicione) os Estágios necessários. Você pode definir qualquer número de estágios para o modelo de workflow.

    Por exemplo:

    wf-08-1

  4. Clique em Salvar e fechar para salvar as propriedades.

  5. Atribua um estágio a cada uma das etapas no modelo de fluxo de trabalho. Por exemplo:

    wf-09

    Um estágio pode ser atribuído a mais de uma etapa. Por exemplo:

    Etapa Estágio
    Etapa 1 Criar
    Etapa 2 Criar
    Etapa 3 Análise
    Etapa 4 Aprovar
    Etapa 5 Aprovar
    Etapa 6 Concluir
  6. Confirme as alterações com Sync (barra de ferramentas do editor) para gerar o modelo de tempo de execução.

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

Exportar um modelo de fluxo de trabalho em um pacote

Para exportar um modelo de fluxo de trabalho em um pacote:

  1. Crie um novo pacote usando o Gerenciador de Pacotes:

    1. Navegue até o Gerenciador de Pacotes por Ferramentas, Implantação, Pacotes.

    2. Clique em Criar pacote.

    3. Especifique o Nome do Pacote e quaisquer outros detalhes conforme necessário.

    4. Clique em OK.

  2. Clique em Edit na barra de ferramentas do novo pacote.

  3. Abra a guia Filters .

  4. Selecione Adicionar filtro e especifique o caminho do modelo de fluxo de trabalho design:

    /conf/global/settings/workflow/models/<*your-model-name*>

    Clique em Concluído.

  5. Selecione Adicionar Filtro e especifique o caminho do seu modelo de fluxo de trabalho de tempo de execução:

    /var/workflow/models/<*your-model-name*>

    Clique em Concluído.

  6. Adicione filtros adicionais para qualquer script personalizado usado pelo seu modelo.

  7. Clique em Save para confirmar as definições de filtro.

  8. Selecione Build na barra de ferramentas da definição de pacote.

  9. Selecione Download na barra de ferramentas do pacote.

Uso de fluxos de trabalho para processar envios de formulário

Você pode configurar um formulário a ser processado pelo workflow selecionado. Quando os usuários enviam o formulário, uma nova instância de fluxo de trabalho é criada com os dados do envio do formulário como carga útil.

Para configurar o workflow a ser usado com seu formulário:

  1. Crie uma nova página e abra-a para edição.

  2. Adicione um componente Formulário à página.

  3. ​Configure o componente ​Início do formulário que apareceu na página.

  4. Use Iniciar fluxo de trabalho para selecionar o fluxo de trabalho desejado dentre os disponíveis:

    wf-12

  5. Confirme a configuração do novo formulário com a marca de verificação.

Teste de fluxos de trabalho

Ao testar um fluxo de trabalho, é uma boa prática usar diversos tipos de carga útil. incluindo tipos diferentes daqueles para os quais foi desenvolvido. Por exemplo, se você pretende que seu fluxo de trabalho lida com Ativos, teste-o definindo uma Página como carga útil e verifique se ela não gera erros.

Por exemplo, teste seu novo fluxo de trabalho da seguinte maneira:

  1. Inicie seu modelo de fluxo de trabalho pelo console.

  2. Defina o Carga e confirme.

  3. Execute as ações conforme necessário para que o fluxo de trabalho continue.

  4. Monitore os arquivos de log enquanto o workflow está em execução.

Você também pode configurar AEM para exibir mensagens DEBUG nos arquivos de log. Consulte Registro para obter mais informações e quando o desenvolvimento for concluído, defina o Nível de Log de volta para Informações.

Exemplos

Exemplo: Criação de um fluxo de trabalho (simples) para aceitar ou rejeitar uma solicitação de publicação

Para ilustrar algumas das possibilidades para criar um workflow, o exemplo a seguir cria uma variação do workflow Publish Example.

  1. Crie um novo modelo de fluxo de trabalho.

    O novo workflow conterá:

    • Início do fluxo
    • Step 1
    • Final do fluxo
  2. Exclua Step 1 (já que é o tipo de etapa errado para este exemplo):

    • Clique na etapa e selecione Excluir na barra de ferramentas do componente. Confirme a ação.
  3. Na seleção Workflow do navegador de etapas, arraste uma Etapa do Participante para o workflow e a posicione entre Início do Fluxo e Fim do Fluxo.

  4. Para abrir a caixa de diálogo de propriedades, faça o seguinte:

    • Clique na etapa do participante e selecione Configurar na barra de ferramentas do componente.
    • Clique duas vezes na etapa do participante.
  5. Na guia Comum, digite Validate Content para o Título e Descrição.

  6. Abra a guia Usuário/Grupo :

    • Ative Notificar usuário por email.
    • Selecione Administrator ( admin) para o campo Usuário/Grupo.
  7. Confirme as atualizações com a marca de verificação.

    Você retornará à visão geral do modelo de fluxo de trabalho, onde a etapa do participante terá sido renomeada para Validate Content.

  8. Arraste um ou Split para o workflow e posicione-o entre Validate Content e Fim do Fluxo.

  9. Abra o ou Split para configuração.

  10. Configurar:

    • Frequentes: especifique o nome da divisão.

    • Ramificação 1: selecione Rota padrão.

    • Ramificação 2: verifique se as Rotas padrão não estão selecionadas.

  11. Confirme suas atualizações no OU Split.

  12. Arraste um Etapa do participante para a ramificação à esquerda, abra as propriedades, especifique os seguintes valores e confirme as alterações:

    • Título: Reject Publish Request

    • Usuário/grupo: por exemplo, projects-administrators

    • Notificar usuário por email: Ative para que o usuário seja notificado por email.

  13. Arraste um Etapa do Processo para a ramificação direita, abra as propriedades, especifique os seguintes valores e confirme as alterações:

    • Título: Publish Page as Requested

    • Processo: selecione Activate Page. Esse processo publica a página selecionada nas instâncias do editor.

  14. Clique em Sync (barra de ferramentas do editor) para gerar o modelo de tempo de execução.

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

    O novo modelo de fluxo de trabalho terá a seguinte aparência:

    wf-13

  15. Aplique esse fluxo de trabalho à sua página, de modo que, quando o usuário mudar para Complete a etapa Validar conteúdo, possa selecionar se deseja Publicar página como solicitado ou Rejeitar solicitação de publicação.

    chlimage_1-72

Exemplo: Definição de uma regra para uma divisão OR usando um script ECMA

OU Spliteps permitem que você introduza caminhos de processamento condicional no seu fluxo de trabalho.

Para definir uma regra OU, proceda da seguinte maneira:

  1. Crie dois scripts e salve-os no repositório, por exemplo, em:

    /apps/myapp/workflow/scripts

    OBSERVAÇÃO

    Os scripts devem ter uma função check() que retorne um booleano.

  2. Edite o workflow e adicione o OU Split ao modelo.

  3. Edite as propriedades de Branch 1 do OR Split:

    • Defina isso como o Rota padrão definindo o Valor como true.

    • Como Rule, defina o caminho para o script. Por exemplo:

      /apps/myapp/workflow/scripts/myscript1.ecma

    OBSERVAÇÃO

    Você pode alternar a ordem da ramificação, se necessário.

  4. Edite as propriedades da Ramificação 2 do OU Split.

    • Como Rule, defina o caminho para o outro script. Por exemplo:

      /apps/myapp/workflow/scripts/myscript2.ecma

  5. Defina as propriedades das etapas individuais em cada ramificação. Verifique se User/Group está definido.

  6. Clique em Sincronizar (barra de ferramentas do editor) para continuar suas alterações no modelo de tempo de execução.

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

Função Check()

OBSERVAÇÃO

Consulte Usando ECMAScript.

O script de amostra a seguir retornará true se o nó for um JCR_PATH localizado em /content/we-retail/us/en:

function check() {
    if (workflowData.getPayloadType() == "JCR_PATH") {
      var path = workflowData.getPayload().toString();
      var node = jcrSession.getItem(path);

      if (node.getPath().indexOf("/content/we-retail/us/en") >= 0) {
       return true;
      } else {
       return false;
      }
     } else {
      return false;
     }
}

Exemplo: Solicitação de ativação personalizada

Você pode personalizar qualquer fluxo de trabalho pronto para uso. Para ter um comportamento personalizado, você sobrepõe os detalhes do fluxo de trabalho apropriado.

Por exemplo, Solicitação de ativação. Esse workflow é usado para publicar páginas em Sites e é acionado automaticamente quando um autor de conteúdo não tem os direitos de replicação apropriados. Consulte Personalização da criação de página - Personalização do fluxo de trabalho de solicitação de ativação para obter mais detalhes.

Nesta página