Práticas recomendadas do fluxo de trabalho

Os workflows permitem que você automatize as atividades Adobe Experience Manager (AEM).

Geralmente, eles representam uma grande quantidade de processamento que ocorre em um ambiente AEM, de modo que, quando as etapas de fluxo de trabalho personalizadas não são gravadas de acordo com as práticas recomendadas ou workflows prontos para uso não são configurados para serem executados com a maior eficiência possível, o sistema pode sofrer como resultado.

Portanto, é altamente recomendável planejar suas implementações de workflows com cuidado.

Configuração

Ao configurar processos de fluxo de trabalho (personalizados e/ou prontos para uso), há algumas coisas que devem ser lembradas.

Workflows transitórios

Para otimizar cargas de ingestão altas, você pode definir um fluxo de trabalho como transitório.

Quando um fluxo de trabalho é temporário, os dados de tempo de execução relacionados às etapas de trabalho intermediárias não são persistentes no JCR quando são executados (as renderizações de saída são, claro, persistentes).

As vantagens podem incluir:

• Redução do tempo de processamento do fluxo de trabalho; de até 10%.
• Reduza significativamente o crescimento do repositório.
• Não são necessários mais workflows CRUD para eliminar.
• Além disso, reduz o número de arquivos TAR para compactar.

Ajustando Workflows DAM

Para obter diretrizes de ajuste de desempenho para workflows DAM, consulte o AEM Assets Performance Tuning Guide.

Configurar o número máximo de Workflows simultâneos

AEM pode permitir que vários processos de fluxo de trabalho sejam executados simultaneamente. Por padrão, o número de threads é configurado para ser metade do número de núcleos do processador no sistema.

Nos casos em que os workflows que estão sendo executados exigem recursos do sistema, isso pode significar que pouco AEM será usado para outras tarefas, como a renderização da interface de criação. Como resultado, o sistema pode ficar lento durante atividades como o carregamento de imagens em massa.

Para resolver esse problema, a Adobe recomenda configurar o número de Máximo de trabalhos paralelos para que seja entre meio e três quartos do número de núcleos do processador no sistema. Isso deve permitir capacidade suficiente para que o sistema continue respondendo ao processar esses workflows.

Para configurar Máximo de Trabalhos Paralelos, você pode:

• Configure Configuração do OSGi a partir do console da Web AEM; para Fila: Fila de Fluxo de Trabalho Granite (uma Configuração da Fila de Trabalho Apache Sling).

• Configure a fila a partir da opção Trabalhos Sling do console da Web AEM; para Configuração da fila de trabalhos: Fila de Fluxo de Trabalho Granite, em http://localhost:4502/system/console/slingevent.

Além disso, há uma configuração separada para a Fila de Trabalho de Processo Externo do Fluxo de Trabalho Granite. Isso é usado para processos de fluxo de trabalho que iniciam binários externos, como InDesign Server ou Image Magick.

Configurar filas de trabalho individuais

Em alguns casos, é útil configurar filas de trabalhos individuais para controlar threads simultâneos, ou outras opções de fila, com base em tarefas individuais. Você pode adicionar e configurar uma fila individual do console da Web por meio da fábrica Configuração da fila de trabalhos do Apache Sling. Para localizar o tópico apropriado para a lista, execute o modelo do seu fluxo de trabalho e procure-o no console Sling Jobs; por exemplo, em http://localhost:4502/system/console/slingevent.

As filas de trabalhos individuais também podem ser adicionadas para workflows transitórios.

Configurar Expurgação do Fluxo de Trabalho

Em uma instalação padrão, o AEM fornece um console de manutenção onde atividades de manutenção diárias e semanais podem ser programadas e configuradas; por exemplo, em:

http://localhost:4502/libs/granite/operations/content/maintenance.html

Por padrão, a Janela Manutenção semanal tem uma tarefa Expurgação do fluxo de trabalho, mas isso precisa ser configurado antes de ser executado. Para configurar expurgações de fluxo de trabalho, uma nova Configuração de Expurgação de Fluxo de Trabalho de Adobe Granite deve ser adicionada ao console da Web.

Para obter mais detalhes sobre tarefas de manutenção em AEM, consulte o Painel Operações.

Personalização

Ao escrever processos de fluxo de trabalho personalizados, há algumas coisas que devem ser levadas em consideração.

Localizações

As definições de modelos de fluxo de trabalho, lançadores, scripts e notificações são mantidas no repositório de acordo com o tipo; ou seja, fora da caixa, personalizado, entre outros.

Locais - Modelos de fluxo de trabalho

Os modelos de fluxo de trabalho são armazenados no repositório de acordo com o tipo:

• Os designs de fluxo de trabalho predefinidos são mantidos no seguinte caminho:

  /libs/settings/workflow/models/

  CUIDADO

  Não:

  • coloque qualquer um dos seus modelos de fluxo de trabalho personalizados nesta pasta
  • editar qualquer item em /libs

  Como qualquer alteração pode ser substituída na atualização ou ao instalar hot fixes, pacotes de correção cumulativos ou service packs.

• Os designs de fluxo de trabalho personalizados são mantidos em:

  /conf/global/settings/workflow/models/...
  

• Os designs de fluxo de trabalho de tempo de execução (prontos para uso e personalizados) são mantidos no seguinte caminho:

  /var/workflow/models/

• Os designs de fluxo de trabalho herdados (tempo de design e tempo de execução) são mantidos no seguinte caminho:

  /etc/workflow/models/

  OBSERVAÇÃO

  Se esses designs forem editados usando a interface de usuário AEM, os detalhes serão copiados para os novos locais.

Locais - Iniciadores de fluxo de trabalho

As definições do iniciador do fluxo de trabalho também são armazenadas no repositório de acordo com o tipo:

• Os iniciadores de fluxo de trabalho predefinidos são mantidos no seguinte caminho:

  /libs/settings/workflow/launcher/

  CUIDADO

  Não:

  • coloque qualquer um dos seus iniciadores de fluxo de trabalho personalizados nesta pasta
  • editar qualquer item em /libs

  Como qualquer alteração pode ser substituída na atualização ou ao instalar hot fixes, pacotes de correção cumulativos ou service packs.

• Os iniciadores de fluxo de trabalho personalizados são mantidos em:

  /conf/global/settings/workflow/launcher/...
  

• Os iniciadores de fluxo de trabalho herdados são mantidos sob o seguinte caminho:

  /etc/workflow/launcher/

  OBSERVAÇÃO

  Se essas definições forem editadas usando a interface de usuário AEM, os detalhes serão copiados para os novos locais.

Locais - Scripts de fluxo de trabalho

Os scripts de fluxo de trabalho também são armazenados no repositório de acordo com o tipo:

• Os scripts de fluxo de trabalho predefinidos são mantidos no seguinte caminho:

  /libs/workflow/scripts/

  CUIDADO

  Não:

  • coloque qualquer um dos scripts de fluxo de trabalho personalizados nesta pasta
  • editar qualquer item em /libs

  Como qualquer alteração pode ser substituída na atualização ou ao instalar hot fixes, pacotes de correção cumulativos ou service packs.

• Os scripts de fluxo de trabalho personalizados são mantidos em:

  /apps/workflow/scripts/...
  

• Scripts de fluxo de trabalho herdados são mantidos sob o seguinte caminho:

  /etc/workflow/scripts/

Locais - Notificações de fluxo de trabalho

As notificações de fluxo de trabalho também são armazenadas no repositório de acordo com o tipo:

• As definições de notificação de fluxo de trabalho predefinidas são mantidas no seguinte caminho:

  /libs/settings/workflow/notification/

  CUIDADO

  Não:

  • coloque qualquer uma de suas definições de notificação de fluxo de trabalho personalizadas nesta pasta
  • editar qualquer item em /libs

  Como qualquer alteração pode ser substituída na atualização ou ao instalar hot fixes, pacotes de correção cumulativos ou service packs.

• As definições de notificação de fluxo de trabalho personalizado são mantidas em:

  /conf/global/settings/workflow/notification/...
  

  OBSERVAÇÃO

  Se desejar substituir um texto de notificação de fluxo de trabalho, crie um caminho sobreposto em:

  /conf/global/settings/workflow/notification/<path-under-libs>

• As definições de notificação de fluxo de trabalho herdado são mantidas no seguinte caminho:

  /etc/workflow/notification/

Sessões de Processo

Como em qualquer desenvolvimento personalizado, sempre é recomendável usar uma sessão de usuário quando possível:

• para melhor cumprimento das diretrizes de segurança
• para permitir que o sistema gerencie a abertura e o fechamento da sessão

Ao implementar um processo de fluxo de trabalho:

• Uma sessão de fluxo de trabalho será fornecida e deverá ser usada, a menos que haja uma razão convincente para não o fazer.
• As novas sessões não devem ser criadas a partir das etapas do fluxo de trabalho, pois isso causa inconsistências no(s) estado(s) juntamente com possíveis problemas de simultaneidade no motor de workflow.
• Você não deve adquirir uma nova sessão JCR de dentro de uma etapa do processo em um fluxo de trabalho; você deve adaptar a sessão do fluxo de trabalho fornecida pela API de Etapa do Processo a uma sessão jcr. Por exemplo:

public void execute(WorkItem item, WorkflowSession workflowSession, MetaDataMap args) throws WorkflowException {
        // to obtain a jcr session:
        javax.jcr.Session jcrSession = workflowSession.adaptTo(javax.jcr.Session.class);

        // to obtain a sling resource resolver:
        org.apache.sling.api.resource.ResourceResolver slingResourceResolver = workflowSession.adaptTo(org.apache.sling.api.resource.ResourceResolver.class);

Salvando uma sessão:

• Dentro de um processo de fluxo de trabalho, se WorkflowSession estiver sendo usado para modificar o repositório, não salve explicitamente a sessão - o fluxo de trabalho salvará a sessão quando ela for concluída.

• Session.Save não deve ser chamado de dentro de uma etapa de fluxo de trabalho:

  • recomenda-se adaptar a sessão jcr do fluxo de trabalho; então save não é necessário, pois o motor de workflow salva a sessão automaticamente assim que o fluxo de trabalho terminar de ser executado.
  • não é recomendado que uma etapa do processo crie sua própria sessão jcr.

• Ao eliminar economias desnecessárias, você pode reduzir a sobrecarga e, assim, tornar os workflows mais eficientes.

Minimizar o número/escopo de iniciadores

Há um listener responsável por todos os iniciadores de fluxo de trabalho que estão registrados:

• Ele vai acompanhar as mudanças em todos os caminhos especificados nas propriedades de globalização dos outros lançadores.
• Quando um evento é despachado, o motor de workflow avaliará cada iniciador para determinar se ele deve ser executado.

Criar muitos lançadores fará com que o processo de avaliação seja executado mais lentamente.

A criação de um caminho de globalização na raiz do repositório em um único iniciador faria com que o motor de workflow ouvisse e avaliasse eventos de criação/modificação em cada nó no repositório. Por essa razão, recomenda-se criar apenas os iniciadores necessários e tornar o caminho de globalização o mais específico possível.

Devido ao impacto desses iniciadores no comportamento do fluxo de trabalho, também pode ser útil desativar os iniciadores prontos para uso que não estejam em uso.

Aprimoramentos de configuração para Iniciadores

A configuração personalizada iniciador foi aprimorada para suportar o seguinte:

• Têm várias condições "AND" juntas.
• Ter condições OU em uma única condição.
• Desabilitar/habilitar iniciadores com base no fato de um sinalizador de recurso estar habilitado ou desabilitado.
• Regex de suporte em condições de lançamento.

Não Start Workflows de outros Workflows

Os workflows podem carregar uma quantidade significativa de sobrecarga, tanto em termos de objetos criados na memória quanto em nós rastreados no repositório. Por essa razão, é melhor fazer com que um fluxo de trabalho faça seu processamento dentro de si mesmo em vez de start workflows adicionais.

Um exemplo disso seria um fluxo de trabalho que implementa um processo de negócios em um conjunto de conteúdo e, em seguida, ativa esse conteúdo. É melhor criar um processo de fluxo de trabalho personalizado que ative cada um desses nós, em vez de iniciar um modelo Ativar conteúdo para cada um dos nós de conteúdo que precisam ser publicados. Essa abordagem exigirá trabalho de desenvolvimento adicional, mas é mais eficiente quando executada do que iniciar uma instância de fluxo de trabalho separada para cada ativação.

Outro exemplo seria um fluxo de trabalho que processa vários nós, cria um pacote de fluxo de trabalho e, em seguida, ativa esse pacote. Em vez de criar o pacote e, em seguida, iniciar um fluxo de trabalho separado com o pacote como carga, você pode alterar a carga do fluxo de trabalho na etapa que cria o pacote e, em seguida, chamar a etapa para ativar o pacote dentro do mesmo modelo de fluxo de trabalho.

Handler avançado

Ao projetar um modelo de fluxo de trabalho, você tem a opção de ativar o avanço do manipulador nas etapas do fluxo de trabalho. Como alternativa, você pode adicionar código à etapa do fluxo de trabalho para determinar qual etapa deve ser executada em seguida e, em seguida, executá-la.

Recomenda-se usar o handler advanced, pois ele oferece melhor desempenho.

Etapas do fluxo de trabalho

Você pode definir estágios do fluxo de trabalho e, em seguida, atribuir tarefas/etapas a uma etapa específica do fluxo de trabalho.

Essas informações são usadas para exibir o progresso de um fluxo de trabalho quando você clica na guia Informações do fluxo de trabalho de um item de trabalho da Caixa de entrada. Os modelos de fluxo de trabalho existentes podem ser editados para adicionar estágios.

Ativar Etapa do Processo de Página

A etapa Ativar processo de página ativará as páginas para você, mas não encontrará automaticamente quaisquer ativos DAM referenciados e os ativará também.

Isso é algo que deve ser lembrado se você planeja usar essa etapa como parte de um modelo de fluxo de trabalho.

Considerações sobre atualização

Ao atualizar sua instância:

• verifique se foi feito backup de todos os modelos de fluxo de trabalho personalizados antes de atualizar uma instância.

• confirme se nenhum de seus workflows personalizados está armazenado em location:

  • /libs/settings/workflow/models/projects

Ferramentas do sistema

Há muitas ferramentas de sistema disponíveis para ajudar com workflows de monitoramento, manutenção e solução de problemas. Todos os URLs de exemplo abaixo usam localhost:4502, mas devem estar disponíveis em qualquer instância do autor ( <hostname>:<port>).

Sling Job Handling Console

http://localhost:4502/system/console/slingevent

O console Sling Job Handling mostrará:

• Estatísticas sobre o estado dos trabalhos no sistema desde a última reinicialização.
• Ele também mostrará as configurações de todas as filas de trabalhos e fornecerá um atalho para editá-las no gerenciador de configurações.

Ferramenta de relatório de fluxo de trabalho

A ferramenta de relatórios do fluxo de trabalho está sendo removida na versão 6.3 para evitar a degradação do desempenho.

MBean de operações de manutenção de fluxo de trabalho

http://localhost:4502/system/console/jmx/com.adobe.granite.workflow:type=Maintenance

O MBean de manutenção de fluxo de trabalho expõe várias rotinas de manutenção úteis, como expurgar workflows concluídos e recuperar estatísticas de fluxo de trabalho.

Informações adicionais

Para obter mais informações, consulte:

• Trabalhar com fluxos de trabalho
• Administração de Workflows
• Desenvolvimento e extensão de Workflows
• Otimização do desempenho