Criando Modelos de Fluxo de Trabalho

CUIDADO

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

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

Quando um usuário start um fluxo de trabalho, uma instância é iniciada; este é o modelo de tempo de execução correspondente, criado quando você Sincronizar suas alterações.

Criando um novo fluxo de trabalho

Quando você cria um novo modelo de fluxo de trabalho, ele contém:

  • As etapas, Start de fluxo e Fim de fluxo.

    Elas representam o início e o fim do fluxo de trabalho. Essas etapas são obrigatórias e não podem ser editadas ou removidas.

  • Um exemplo de Participante etapa chamado Etapa 1.

    Esta etapa está 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 fluxo de trabalho com o editor:

  1. Abra o console Modelos de Fluxo de Trabalho; por meio de Ferramentas, Fluxo de trabalho, Modelos ou, por exemplo:

    http://localhost:4502/aem/workflow

  2. Selecione Criar e Criar Modelo.

  3. A caixa de diálogo Adicionar modelo de fluxo de trabalho é exibida. Insira Title e Nome (opcional) antes de selecionar Concluído.

  4. O novo modelo está listado no console Modelos de Fluxo de Trabalho.

  5. Selecione seu novo fluxo de trabalho e use Editar​para abri-lo para configuração:

    wf-01

OBSERVAÇÃO

Se estiver criando modelos de forma programática (usando um pacote crx), você também poderá criar uma subpasta dentro de:

/var/workflow/models

Por exemplo, /var/workflow/models/prototypes

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

Editando um fluxo de trabalho

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

Editar um fluxo de trabalho Padrão ou Herdado (predefinido) tem uma etapa adicional, para garantir que uma cópia segura seja realizada antes de suas alterações serem feitas.

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

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

A sincronização (à 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 start 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 Sincronizar para gerar um modelo de tempo de execução - mesmo quando as caixas de diálogo individuais (por exemplo, para etapas) têm suas próprias opções de gravação.

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

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

wf-21

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

Quando você abre um Modelo padrão e/ou herdado para edição:

  • O navegador Etapas não está disponível (lado esquerdo).

  • Há uma ação Editar disponível na barra de ferramentas (lado direito).

  • Inicialmente, o modelo e suas propriedades são apresentados em modo somente leitura como:

    • Os workflows padrão estão localizados em /libs
    • Os workflows herdados estão localizados em /etc

Selecionar Editar irá:

  • faça uma cópia do fluxo de trabalho em /conf
  • disponibilize o navegador 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

Adicionando 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 AEM padrão.

Quando você edita um modelo, as etapas disponíveis são exibidas nos vários grupos do navegador Etapas. Por exemplo:

wf-10

OBSERVAÇÃO

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

Para adicionar uma etapa a um modelo:

  1. Abra um modelo de fluxo de trabalho existente para edição. No console Modelo de Workflows, 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-stepinfo-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 adicioná-lo 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 de etapa, você pode arrastá-los para um local diferente no modelo.

    Você também pode 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-collapseexpande-barra-ferramentas-ícone

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

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

Configurando uma Etapa do Fluxo de Trabalho

Você pode Configurar e personalizar o comportamento de uma etapa do 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:

    • Toque na etapa do modelo de fluxo de trabalho e selecione Configurar na barra de ferramentas do componente.
    • Duplo-clique na etapa.
    OBSERVAÇÃO

    Para obter informações sobre os componentes de etapa primária 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, está presente em um novo fluxo de trabalho como Step 1:

    wf-11

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

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

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

Criando um Fluxo de Trabalho Transitório

Você pode criar um modelo de fluxo de trabalho Transitório ao criar um novo modelo ou ao editar um 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 Fluxo de trabalho temporário (ou desative se necessário):

    wf-07

  4. Confirme a alteração com Salvar e Fechar; seguido por Sincronizar (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 fluxo de trabalho no modo transient AEM não armazena nenhum histórico de fluxo de trabalho. Portanto, Linha do tempo não exibe nenhuma informação relacionada a esse fluxo de trabalho. 🔗

Disponibilize os modelos de fluxo de trabalho na interface do usuário para 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 usuário 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 Fluxo de trabalho do Start 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 Fluxo de trabalho.

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

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

  5. Selecione Editar e abra Propriedades do Modelo de Fluxo de Trabalho. Vá para a guia Basic.

  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 Save & Close.
    Editar propriedades da página do modelo

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

Configuração de 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 ao editar um 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 Sincronizar (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)

Os Stageshelp do fluxo de trabalho visualizam o progresso de um fluxo de trabalho ao manipular tarefas.

CUIDADO

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).

As fases a disponibilizar são definidas nos modelos de fluxo de trabalho; os modelos de fluxo de trabalho existentes podem ser atualizados para incluir definições de estágio. É possível definir qualquer número de estágios para o modelo de fluxo de trabalho.

Para definir Estágios para o 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 Estágios.

  3. Adicione (e posicione) seus Estágios necessários. É possível definir qualquer número de estágios para o modelo de fluxo de trabalho.

    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

    Uma etapa pode ser atribuída 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 Sincronizar (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

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

    1. Navegue até o Gerenciador de pacotes por meio de Ferramentas, Implantação, Pacotes.
    2. Clique em Criar pacote.
    3. Especifique Nome do pacote e quaisquer outros detalhes conforme necessário.
    4. Clique em OK.
  2. Clique em Editar na barra de ferramentas do novo pacote.

  3. Abra a guia Filtros.

  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 modelo de fluxo de trabalho runtime:

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

    Clique em Concluído.

  6. Adicione filtros adicionais para quaisquer scripts personalizados usados pelo seu modelo.

  7. Clique em Salvar para confirmar as definições do filtro.

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

  9. Selecione Baixar na barra de ferramentas do pacote.

Uso de Workflows para processar envios de formulário

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

Para configurar o fluxo de trabalho a ser usado com o formulário:

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

  2. Adicione um componente Form à página.

  3. Configure o componente Start de formulário que apareceu na página.

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

    wf-12

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

Testando Workflows

É uma boa prática testar um fluxo de trabalho para 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 os Ativos, teste-o configurando uma Página como carga e certifique-se de que ela não apresenta erros.

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

  1. Start seu modelo de fluxo de trabalho do console.

  2. Defina Carga e confirme.

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

  4. Monitore os arquivos de registro enquanto o fluxo de trabalho estiver em execução.

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

Exemplos

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

Para ilustrar algumas das possibilidades de criação de um fluxo de trabalho, o exemplo a seguir cria uma variação do fluxo de trabalho Publish Example.

  1. Crie um novo modelo de fluxo de trabalho.

    O novo fluxo de trabalho conterá:

    • Início do fluxo
    • Step 1
    • Final do fluxo
  2. Excluir Step 1 (pois é o tipo de etapa incorreto para este exemplo):

    • Clique na etapa e selecione Excluir na barra de ferramentas do componente. Confirme a ação.
  3. Na seleção Fluxo de trabalho do navegador de etapas, arraste uma Etapa do participante para o fluxo de trabalho e posicione-o entre Start de fluxo e Fim de fluxo.

  4. Para abrir a caixa de diálogo de propriedades:

    • Clique na etapa participante e selecione Configurar na barra de ferramentas do componente.
    • Duplo-clique na etapa do participante.
  5. Na guia Common, digite Validate Content para as opções Title e Description.

  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ê voltará à visão geral do modelo de fluxo de trabalho, onde a etapa do participante será renomeada para Validate Content.

  8. Arraste um Ou Dividir para o fluxo de trabalho e posicione-o entre Validate Content e Fim de Fluxo.

  9. Abra Ou Divida para obter a configuração.

  10. Configurar:

    • Frequentes: selecionar 2 ramificações
    • 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 em OU Dividir.

  12. Arraste uma 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 o usuário por email: Ative para que o usuário seja notificado por email.
  13. Arraste uma 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 Sincronizar (barra de ferramentas do editor) para gerar o modelo de tempo de execução.

    Consulte Sincronizar seu fluxo de trabalho para obter detalhes.

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

    wf-13

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

    chlimage_1-182

Exemplo: Definindo uma regra para uma divisão OR

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

Para definir uma regra OU:

  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 fluxo de trabalho e adicione OU Dividir ao modelo.

  3. Edite as propriedades de Ramificação 1 de OU Dividir:

    • Defina isso como a Rota padrão definindo 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 de ramificação, se necessário.

  4. Edite as propriedades de Ramificação 2 de OU Dividir.

    • 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 persistir 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 personalizada para Ativação

Você pode personalizar qualquer um dos workflows prontos para uso. Para ter um comportamento personalizado, sobreponha os detalhes do fluxo de trabalho apropriado.

Por exemplo, Solicitação de Ativação. Esse fluxo de trabalho é 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 Personalizando a criação de páginas - Personalizando a solicitação para o fluxo de trabalho de Ativação para obter mais detalhes.

Nesta página

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now