Criação de modelos de fluxo de trabalho creating-workflow-models

CAUTION
Para uso da 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 do modelo, como se o fluxo de trabalho é transitório ou usa vários recursos.

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

Criação de um novo fluxo de trabalho creating-a-new-workflow

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

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

Para criar um workflow com o editor:

  1. Abra o console Modelos de Fluxo de Trabalho; via Ferramentas, Fluxo de Trabalho, Modelos ou, por exemplo: https://localhost:4502/aem/workflow
  2. Selecione Criar e depois Criar Modelo.
  3. A caixa de diálogo Adicionar modelo de fluxo de trabalho é exibida. Insira o Título e o Nome (opcional) antes de selecionar Concluído.
  4. O novo modelo está listado no console Modelos de Fluxo de Trabalho.
  5. Selecione o novo fluxo de trabalho e use a Edição para abri-lo para a configuração:
    wf-01
NOTE
Se estiver criando modelos de forma programática (usando um pacote crx), você também pode criar uma subpasta em:
/var/workflow/models
Por exemplo, /var/workflow/models/prototypes
Esta pasta pode ser usada para gerenciar o acesso aos modelos nessa pasta.

Editar um fluxo de trabalho editing-a-workflow

É possível editar qualquer modelo de workflow existente para:

A edição de um fluxo de trabalho Padrão e/ou Herdado (pronto para uso) tem uma etapa adicional, para garantir que uma cópia segura seja feita antes das alterações.

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

Sincronizar o fluxo de trabalho - Gerar um modelo em tempo de execução sync-your-workflow-generate-a-runtime-model

Sync (à direita da 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, elas 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, deve usar Sincronizar 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), Sincronizado é exibido.

Algumas etapas têm campos obrigatórios e/ou validação integrada. Quando estas condições não são satisfeitas um erro é mostrado quando você tenta Sincronizar o modelo. Por exemplo, quando nenhum participante tiver sido definido para uma etapa Participante:

wf-21

Edição de um fluxo de trabalho padrão ou herdado pela primeira vez editing-a-default-or-legacy-workflow-for-the-first-time

Ao abrir um modelo Padrão e/ou Herdado para edição:

  • O navegador de 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 no modo somente leitura como:

    • Os fluxos de trabalho padrão estão em /libs
    • Os fluxos de trabalho herdados estão em /etc
      Selecionar Editar irá:
  • fazer uma cópia do fluxo de trabalho em /conf

  • disponibilizar o navegador de Etapas

  • permitir que você faça alterações

NOTE
Consulte Locais de Modelos de Fluxo de Trabalho para obter mais informações.

wf-22

Adicionar uma etapa a um modelo adding-a-step-to-a-model

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

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

wf-10

NOTE
Para obter informações sobre os componentes principais da etapa instalados com AEM, consulte Referência a 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 Editar.

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

    • Filtre por 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 adicionado ao fluxo, você pode configurar a etapa.

    wf-03

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

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

    Você também pode copiar, recortar, colar, agrupar ou excluir etapas existentes; como acontece com o editor de páginas.

    Etapas divididas também podem ser recolhidas/expandidas usando a opção de 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 o fluxo de trabalho para obter detalhes.

Configurar uma etapa do fluxo de trabalho configuring-a-workflow-step

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:

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

    • Clique duas vezes na etapa.

    note note
    NOTE
    Para obter informações sobre os componentes principais da etapa instalados com AEM, consulte Referência a Etapas do Fluxo de Trabalho.
  2. Configure as Propriedades de Etapa conforme necessário; as propriedades disponíveis dependem do tipo de etapa; também pode haver várias guias disponíveis. Por exemplo, a Etapa do participante padrão, presente em um novo fluxo de trabalho como Step 1:

    wf-11

  3. Confirme suas atualizações com a marca.

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

    Consulte Sincronizar o fluxo de trabalho para obter detalhes.

Criar um fluxo de trabalho temporário creating-a-transient-workflow

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

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

  2. Selecione Propriedades do Modelo de Fluxo de Trabalho na barra de ferramentas.

  3. Na caixa de diálogo, ative o Fluxo de Trabalho Transitó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 o fluxo de trabalho para obter detalhes.

NOTE
Quando você executa um fluxo de trabalho no modo transitório, o 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.

Disponibilizar modelos de fluxo de trabalho na Interface para toque classic2touchui

Se um modelo de fluxo de trabalho estiver presente na interface clássica, mas 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 a 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 Fluxo de trabalho.

  3. Selecione Criar > Criar Marca. Definir Título como DAM e Nome como dam. Selecione Enviar.
    Criar marca no modelo de fluxo de trabalho

  4. Navegue até Ferramentas > Fluxo de trabalho > Modelos. Selecione Solicitar ativação e 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. Adicionar Workflow : DAM ao campo Marcas. Confirme a seleção com a marca de seleção (marca de seleção).

  7. Confirme a adição da tag com Salvar e Fechar.
    Editar Propriedades da Página do Modelo

  8. Conclua o processo com Sincronizar. 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 configuring-a-workflow-for-multi-resource-support

Você pode configurar um modelo de fluxo de trabalho para o Suporte a Vários Recursos ao criar um modelo ou ao editar um existente:

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

  2. Selecione Propriedades do Modelo de Fluxo de Trabalho na barra de ferramentas.

  3. Na caixa de diálogo, ative o 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 o fluxo de trabalho para obter detalhes.

Configuração de estágios de fluxo de trabalho (que mostram o andamento do fluxo de trabalho) configuring-workflow-stages-that-show-workflow-progress

Estágios do Fluxo de Trabalho ajudam a visualizar o progresso de um fluxo de trabalho ao manipular tarefas.

CAUTION
Se os estágios do fluxo de trabalho estiverem 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 atual do fluxo de trabalho).

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. É possível definir qualquer número de estágios para o modelo de fluxo de trabalho.

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

  3. Adicione (e posicione) os 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 etapa no modelo de fluxo de trabalho. Por exemplo:

    wf-09

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

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
    Etapa Estágio
    Etapa 1 Criar
    Etapa 2 Criar
    Etapa 3 Revisar
    Etapa 4 Aprovar
    Etapa 5 Aprovar
    Etapa 6 Concluído
  6. Confirme as alterações com Sync (barra de ferramentas do editor) para gerar o modelo de tempo de execução.

    Consulte Sincronizar o fluxo de trabalho para obter detalhes.

Exportação de um modelo de fluxo de trabalho em um pacote exporting-a-workflow-model-in-a-package

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

  1. Criar um 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 o 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 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 Salvar para confirmar as definições de filtro.

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

  9. Selecione Baixar na barra de ferramentas do pacote.

Utilização de fluxos de trabalho para processar envios de formulários using-workflows-to-process-form-submissions

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 sua carga.

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

  1. Crie uma 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 entre os disponíveis:

    wf-12

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

Testar fluxos de trabalho testing-workflows

Ao testar um fluxo de trabalho, é recomendável usar vários tipos de carga, incluindo tipos diferentes daquele para o qual ele foi desenvolvido. Por exemplo, se você pretende que seu fluxo de trabalho lide com o Assets, teste-o definindo uma Página como carga útil e certifique-se de que não gere erros.

Por exemplo, teste seu novo workflow da seguinte maneira:

  1. Inicie seu modelo de fluxo de trabalho a partir do console.

  2. Defina a Carga e confirme.

  3. Execute ações conforme necessário para que o workflow continue.

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

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

Exemplos examples

Exemplo: criação de um fluxo de trabalho (simples) para aceitar ou rejeitar uma solicitação de publicação example-creating-a-simple-workflow-to-accept-or-reject-a-request-for-publication

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. Criar um modelo de fluxo de trabalho.

    O novo workflow conterá:

    • Início do fluxo
    • Step 1
    • Fim do Fluxo
  2. Excluir Step 1 (pois é 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 Fluxo de Trabalho do navegador de etapas, arraste uma Etapa de Participante para o fluxo de trabalho e posicione-a entre Início do Fluxo e Fim do Fluxo.

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

    • 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 a Descrição.

  6. Abra a guia Usuário/Grupo:

    • Ativar Notificar usuário via email.
    • Selecione Administrator ( admin) para o campo Usuário/Grupo.
    note note
    NOTE
    Para que emails sejam enviados, o serviço de email e os detalhes da conta de usuário precisam ser configurados.
  7. Confirme as atualizações com a marca de verificação.

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

  8. Arraste um Or Split para o fluxo de trabalho e posicione-o entre Validate Content e Fim do Fluxo.

  9. Abra a Ou a Divisão para configuração.

  10. Configurar o:

    • Comum: especifique o nome da divisão.

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

    • Ramificação 2: certifique-se de que a Rota Padrão não esteja selecionada.

  11. Confirme suas atualizações para a OU Split.

  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 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 valores a seguir 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 o fluxo de trabalho para obter detalhes.

    Seu novo modelo de fluxo de trabalho será semelhante a:

    wf-13

  15. Aplique este fluxo de trabalho à sua página para que, quando o usuário mudar para Concluir a etapa Validar conteúdo, possa selecionar se deseja Página do Publish como Solicitada ou Rejeitar solicitação do Publish.

    chlimage_1-72

Exemplo: Definição de uma Regra para uma Divisão OR usando o script ECMA defineruleecmascript

As etapas OU Split permitem introduzir caminhos de processamento condicional no fluxo de trabalho.

Para definir uma regra OR, proceda da seguinte maneira:

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

    /apps/myapp/workflow/scripts

    note note
    NOTE
    Os scripts devem ter uma função check() que retorne um booleano.
  2. Edite o fluxo de trabalho e adicione a OU Split ao modelo.

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

    • Defina esta como a Rota Padrão definindo o Valor como true.

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

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

    note note
    NOTE
    Você pode alternar a ordem da ramificação, se necessário.
  4. Edite as propriedades da Ramificação 2 de OU Divisão.

    • Como Regra, 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 o Usuário/Grupo está definido.

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

    Consulte Sincronizar o fluxo de trabalho para obter detalhes.

Função Check() function-check

NOTE
Consulte Usando ECMAScript.

O exemplo de script 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 example-customized-request-for-activation

Você pode personalizar qualquer um dos workflows prontos para uso. Para personalizar o comportamento, você sobrepõe os detalhes do fluxo de trabalho apropriado.

Por exemplo, Solicitação de ativação. Este 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 de fluxo de trabalho de ativação para obter mais detalhes.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2