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

CAUTION
AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.
CAUTION
Para usar a interface clássica, consulte o 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 workflow. 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 creating-a-new-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 ou removidas.

  • Um exemplo Participante step com 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 Modelos de fluxo de trabalho console; por meio de Ferramentas, Fluxo de trabalho, Modelos ou, por exemplo:

    http://localhost:4502/aem/workflow

  2. Selecionar Criar, em seguida Criar modelo.

  3. O Adicionar modelo de fluxo de trabalho será exibida. Insira o Título e Nome (opcional) antes de selecionar Concluído.

  4. O novo modelo está listado na variável Modelos de fluxo de trabalho console.

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

    wf-01

NOTE
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 gerenciamento do acesso aos modelos nessa pasta.

Editar um fluxo de trabalho editing-a-workflow

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

Edição de um Padrão ou herdado fluxo de trabalho (pronto para uso) tem uma etapa adicional para garantir que uma cópia segura for tomada 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 o fluxo de trabalho para obter detalhes.

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

Sincronizar (à 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, então 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, você 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 incorporada. 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 um Participante etapa:

wf-21

Editar 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 Etapas O navegador não está disponível (lado esquerdo).

  • Existe um Editar ação 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 Editar irá:

  • faça uma cópia do fluxo de trabalho no /conf
  • faça o Etapas navegador disponível
  • 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

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 em vários grupos da variável Etapas navegador. Por exemplo:

wf-10

NOTE
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 uma etapa a um modelo:

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

  2. Abra o Etapas navegador; usar 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, um 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 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 com o 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 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 uma etapa do fluxo de trabalho configuring-a-workflow-step

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

  1. Para abrir o Propriedades da etapa para uma etapa:

    • Toque na etapa no 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 da etapa principal instalados com o AEM, consulte Referência de etapas do fluxo de trabalho.
  2. Configure o 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 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 o fluxo de trabalho para obter detalhes.

Criação de um fluxo de trabalho transitório creating-a-transient-workflow

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

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

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

  3. Na caixa de diálogo, ative Fluxo de trabalho transitório (ou desativar, se necessário):

    wf-07

  4. Confirme a alteração com Salvar e fechar; seguida de 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
Ao executar um workflow em transient AEM de modo não armazena nenhum histórico do workflow. Por conseguinte, Linha do tempo não exibe informações relacionadas a esse workflow. 🔗

Disponibilizar modelos de fluxo de trabalho na interface do usuário de toque make-workflow-models-available-in-touchui

Se um modelo de fluxo de trabalho estiver presente na interface clássica, mas ausente no menu pop-up de seleção no Linha do tempo painel da interface do usuário de toque, siga a configuração para disponibilizá-la. 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. Acessar um ativo usando /assets.html/content/dam caminho. Selecione um ativo. Abrir Linha do tempo no painel esquerdo. Clique em Iniciar fluxo de trabalho e confirme que Solicitação de ativação O modelo não está presente na lista pop-up.

  2. Navegar Ferramentas > Geral > Marcação. Selecionar Fluxo de trabalho.

  3. Selecionar Criar > Criar tag. Definir Título as DAM e Nome as dam. Selecione Enviar.
    Criar tag no modelo de fluxo de trabalho

  4. Navegar para Ferramentas > Fluxo de trabalho > Modelos. Selecionar Solicitação de ativação, em seguida selecione Editar.

  5. Selecionar Editar , depois abra Propriedades do modelo de fluxo de trabalho. Vá para o Básico guia .

  6. Adicionar Workflow : DAM para Tags campo. 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 Sincronizar. O fluxo de trabalho agora está disponível na interface habilitada para toque.

Configurar 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 Suporte a vários recursos ao criar um novo modelo ou ao editar um modelo existente:

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

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

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

    wf-08

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

    Consulte Sincronizar o fluxo de trabalho para obter detalhes.

Configurando Estágios do Fluxo de Trabalho (que mostram o Progresso do Fluxo de Trabalho) configuring-workflow-stages-that-show-workflow-progress

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

CAUTION
Se os estágios do fluxo de trabalho forem definidos em Propriedades da página, mas não usada 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 seu fluxo de trabalho:

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

  2. Selecionar Propriedades do modelo de fluxo de trabalho na barra de ferramentas. Em seguida, abra o Estágios guia .

  3. Adicione (e posicione) a Estágios. 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:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
    Etapa Fase
    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 o fluxo de trabalho para obter detalhes.

Exportar um modelo de fluxo de trabalho em um pacote exporting-a-workflow-model-in-a-package

  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 a Nome do pacote e quaisquer outros detalhes necessários.
    4. Clique em OK.
  2. Clique em Editar na barra de ferramentas do novo pacote.

  3. Abra o Filtros guia .

  4. Selecionar Adicionar filtro e especifique o caminho do modelo de fluxo de trabalho projeto:

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

    Clique em Concluído.

  5. Selecionar Adicionar filtro e especifique o caminho de sua tempo de execução modelo de fluxo de trabalho:

    /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. Selecionar Criar na barra de ferramentas da definição de pacote.

  9. Selecionar Baixar na barra de ferramentas do pacote.

Uso de fluxos de trabalho para processar envios de formulário 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 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 Formulário para a página.

  3. Configure o Início do formulário componente 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 testing-workflows

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 o modelo de fluxo de trabalho do console.

  2. Defina as 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 DEPURAR mensagens nos arquivos de log. Consulte Registro para obter mais informações e quando o desenvolvimento for concluído, defina a variável Nível de log voltar para Informações.

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 para criar um workflow, o exemplo a seguir cria uma variação do Publish Example fluxo de trabalho.

  1. Criar um novo modelo de fluxo de trabalho.

    O novo workflow conterá:

    • Início do fluxo
    • Step 1
    • Final do fluxo
  2. Excluir Step 1 (como é 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. No Fluxo de trabalho seleção do navegador de etapas, arraste uma Etapa do participante no fluxo de trabalho e posicioná-lo 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. No Frequentes tab enter Validate Content para ambas as Título e Descrição.

  6. Abra o Usuário/Grupo guia :

    • Ativar Notificar usuário por email.
    • Selecionar Administrator ( admin) para o Usuário/Grupo campo.
    note note
    NOTE
    Para enviar emails, os detalhes do serviço de email e da conta de usuário precisam ser configurados.
  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 será renomeada para Validate Content.

  8. Arraste um Ou Dividir no fluxo de trabalho e posicioná-lo entre Validate Content e Fim do Fluxo.

  9. Abra o Ou Dividir para configuração.

  10. Configurar o:

    • Frequentes: select 2 Ramificações
    • Ramificação 1: select Rota padrão.
    • Ramificação 2: garantir Rota padrão não está selecionada.
  11. Confirme suas atualizações na OU Dividir.

  12. Arraste um Etapa do participante na ramificação da 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 na ramificação direita, abra as propriedades, especifique os seguintes valores e confirme as alterações:

    • Título: Publish Page as Requested
    • Processo: select 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.

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

    wf-13

  15. Aplique este fluxo de trabalho à sua página para que, quando o usuário mudar para Concluído o Validar conteúdo , eles podem selecionar se desejam Publicar a página conforme solicitado ou Rejeitar solicitação de publicação.

    chlimage_1-182

Exemplo: Definição de uma regra para uma divisão OR example-defining-a-rule-for-an-or-split

OU Dividir as etapas permitem introduzir caminhos de processamento condicional no 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

    note note
    NOTE
    Os scripts devem ter um função check() que retorna um booleano.
  2. Edite o workflow e adicione o OU Dividir ao modelo.

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

    • Defina como Rota padrão definindo a variável Valor para true.

    • As 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 do Ramificação 2 do OU Dividir.

    • As 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. Certifique-se de que o Usuário/Grupo está definida.

  6. Clique em Sincronizar (barra de ferramentas do editor) para continuar 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 Uso de ECMAScript.

O exemplo de script a seguir retorna true se o nó for um JCR_PATH localizada 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 example-customized-request-for-activation

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 fluxo de trabalho é usado para publicar páginas no 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.

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e