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

Last update: Wed Mar 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

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 workflow. 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 workflow, uma instância é iniciada; esse é o modelo de tempo de execução correspondente, criado quando você Sincronizar 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 Fim 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 Participante etapa 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:

Abra o Modelos de fluxo de trabalho console; via Ferramentas, Fluxo de trabalho, Modelos ou, por exemplo: https://localhost:4502/aem/workflow
Selecionar Criar, depois Criar modelo.
A variável Adicionar modelo de fluxo de trabalho será exibida. Insira o Título e Nome (opcional) antes de selecionar Concluído.
O novo modelo está listado no Modelos de fluxo de trabalho console.
Selecione o novo fluxo de trabalho e use Editar para abri-lo para configuração:

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

Essa pasta pode ser usada para gerenciamento do acesso aos modelos nessa pasta.

Editar um fluxo de trabalho editing-a-workflow

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

definir etapas e seus parâmetros
configurar propriedades do fluxo de trabalho, incluindo estágios, se o fluxo de trabalho é transitório e/ou usa vários recursos

Edição de um Padrão e/ou herdado Fluxo de trabalho (pronto para uso) tem uma etapa adicional, para garantir que uma cópia segura é feita antes de suas alterações.

Quando as atualizações do fluxo de trabalho estiverem concluídas, você deverá usar Sincronizar para Gerar um modelo em 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

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, 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 caixas de diálogo individuais (por exemplo, para etapas) tiverem 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 em vez disso.

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

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 uma Modelo padrão e/ou herdado para edição:

O navegador de Etapas não está disponível (lado esquerdo).
Existe uma 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 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 dos 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 da Navegador de etapas. Por exemplo:

wf-10

NOTE

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

Para adicionar etapas ao modelo de fluxo de trabalho:

Abra um modelo de fluxo de trabalho existente para edição. No Modelo de fluxos de trabalho selecione o modelo necessário e, em seguida, Editar.
Abra o navegador Etapas; usando Ativar/desativar painel lateral, na extremidade esquerda da barra de ferramentas superior. Aqui você pode:
- Filtro para obter 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 para mostrar mais detalhes sobre a etapa apropriada.
Arraste as etapas apropriadas para o local desejado no modelo.

Por exemplo, uma variável Etapa do participante.

Depois de adicionado ao fluxo, você pode configurar a etapa.
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.

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

Etapas divididas também podem ser recolhidas/expandidas usando a opção da barra de ferramentas:
Confirmar 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.

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 o Propriedades da etapa caixas de diálogo.

Para abrir o 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 da etapa principal instalados com AEM, consulte Referência de etapas do fluxo de trabalho.

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:
Confirme suas atualizações com a marca.
Confirmar 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.

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

Você pode criar um Temporário modelo de fluxo de trabalho ao criar um modelo ou ao editar um existente:

Abrir o modelo de fluxo de trabalho para edição.
Selecionar Propriedades do modelo de fluxo de trabalho na barra de ferramentas.
Na caixa de diálogo, ative Fluxo de trabalho transitório (ou desativar, se necessário):
Confirmar 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

Ao executar um fluxo de trabalho no transitório O modo AEM não armazena nenhum histórico de fluxo de trabalho. Por conseguinte, Linha do tempo não exibe nenhuma informação relacionada a esse workflow.

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 na Linha do tempo da interface para toque, siga a configuração para disponibilizá-la. As etapas a seguir ilustram o uso do modelo de fluxo de trabalho chamado Solicitação para ativação.

Confirme se o modelo não está disponível na interface habilitada para toque. Acessar um ativo usando o /assets.html/content/dam caminho. Selecione um ativo. Abertura Linha do tempo no painel esquerdo. Clique em Iniciar fluxo de trabalho e confirmar que a Solicitação para ativação não está presente na lista pop-up.
Navegar até Ferramentas > Geral > Tags. Selecionar Fluxo de trabalho.
Selecionar Criar > Criar tag. Definir Título as DAM e Nome as dam. Selecione Enviar.
Navegue até Ferramentas > Fluxo de trabalho > Modelos. Selecionar Solicitação para ativação e selecione Editar.
Selecionar Editar, abra o Informações da página e, nesse menu, selecione Abrir propriedades e vá para a página Básico (se ainda não estiver aberta).
Adicionar Workflow : DAM para Tags campo. Confirme a seleção com a marca de seleção (marca de seleção).
Confirme a adição da tag com Salvar e fechar.
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

É possível configurar um modelo de fluxo de trabalho para Suporte a vários recursos ao criar um modelo ou editar um existente:

Abrir o modelo de fluxo de trabalho para edição.
Selecionar Propriedades do modelo de fluxo de trabalho na barra de ferramentas.
Na caixa de diálogo, ative Suporte a vários recursos (ou desativar, se necessário):
Confirmar 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 ajuda a visualizar o progresso de um workflow ao manipular tarefas.

CAUTION

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

Abra o modelo de fluxo de trabalho para edição.
Selecionar Propriedades do modelo de fluxo de trabalho na barra de ferramentas. Em seguida, abra o Estágios guia.
Adicione (e posicione) o que for necessário Estágios. É possível definir qualquer número de estágios para o modelo de fluxo de trabalho.

Por exemplo:
Clique em Salvar e fechar para salvar as propriedades.

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

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

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:

Criar um pacote usando o Gerenciador de pacotes:
1. Navegue até o Gerenciador de pacotes via Ferramentas, Implantação, Pacotes.
2. Clique em Criar pacote.
3. Especifique a Nome do pacote e quaisquer outros detalhes conforme necessário.
4. Clique em OK.
Clique em Editar na barra de ferramentas do novo pacote.
Abra o Filtros guia.
Selecionar 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.
Selecionar Adicionar filtro e especifique o caminho do seu tempo de execução modelo de fluxo de trabalho:

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

Clique em Concluído.
Adicione filtros adicionais para qualquer script personalizado usado pelo seu modelo.
Clique em Salvar para confirmar as definições de filtro.
Selecionar Build na barra de ferramentas da definição de pacote.
Selecionar 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:

Crie uma página e abra-a para edição.
Adicionar um Formulário componente à página.
Configurar o Início do formulário componente que apareceu na página.
Uso Iniciar fluxo de trabalho para selecionar o fluxo de trabalho desejado entre os disponíveis:
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 o fluxo de trabalho lide com ativos, 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:

Inicie seu modelo de fluxo de trabalho do console.
Defina o Carga e confirme.
Execute ações conforme necessário para que o workflow continue.
Monitore os arquivos de log enquanto o workflow está em execução.

Também é possível configurar o AEM para exibir DEPURAR nos arquivos de log. Consulte Logs para obter mais informações e quando o desenvolvimento estiver concluído, defina o Nível de registro 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 de criação de um workflow, o exemplo a seguir cria uma variação do Publish Example fluxo de trabalho.

Criar um modelo de fluxo de trabalho.

O novo workflow conterá:
- Início do fluxo
- Step 1
- Fim do fluxo
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.
No Fluxo de trabalho seleção do navegador de etapas, arraste uma Etapa do participante no fluxo de trabalho e posicione-o entre Início do fluxo e Fim do fluxo.
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.
No Comum entrada de guia Validate Content para ambos Título e Descrição.

Abra o Usuário/Grupo guia:

Ativar Notificar usuário por e-mail.
Selecionar Administrator ( admin) para o Usuário/Grupo campo.

note note
NOTE
Para que os emails sejam enviados, os detalhes do serviço de email e da conta de usuário precisam ser configurados.

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

Você retornará para a visão geral do modelo de fluxo de trabalho, em que a etapa do participante será renomeada para Validate Content.
Arraste um Ou dividir no fluxo de trabalho e posicione-o entre Validate Content e Fim do fluxo.
Abra o Ou dividir para configuração.
Configurar o:
- Comum: especifique o nome da divisão.
- Ramificação 1: selecionar Rota Padrão.
- Ramificação 2: certifique-se Rota Padrão não está selecionado.
Confirme suas atualizações na OU dividir.
Arraste um Etapa do participante à 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 e-mail: ative para que o usuário seja notificado por email.
Arraste um Etapa do processo à ramificação direita, abra as propriedades, especifique os seguintes valores e confirme as alterações:
- Título: Publish Page as Requested
- Processo: selecionar Activate Page. Esse processo publica a página selecionada nas instâncias do editor.
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:
Aplique esse fluxo de trabalho à sua página, para que, quando o usuário mudar para Concluído o Validar conteúdo etapa, eles podem selecionar se desejam Publicar página como solicitado ou Rejeitar solicitação de publicação.

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

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

Para definir uma regra OR, proceda da seguinte maneira:

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 valor booleano.

Edite o workflow e adicione o OU dividir para o modelo.

Editar as propriedades de Ramificação 1 do OU dividir:

Defina como o Rota Padrão definindo o Valor para 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.

Edite as propriedades do Ramificação 2 do OU dividir.
- Como Regra, defina o caminho para o outro script. Por exemplo:
  
  /apps/myapp/workflow/scripts/myscript2.ecma
Defina as propriedades das etapas individuais em cada ramificação. Verifique se Usuário/Grupo está definido.
Clique em Sincronizar (barra de ferramentas do editor) para manter as 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 Utilização do ECMAScript.

O exemplo de script a seguir retorna 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 para 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 da solicitação para o fluxo de trabalho de ativação para obter mais detalhes.

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2