Práticas recomendadas do workflow

Os workflows permitem automatizar as atividades do Adobe Experience Manager (AEM).

Geralmente, eles representam uma grande quantidade do processamento que ocorre em um ambiente de AEM, de modo que, quando as etapas do fluxo de trabalho personalizado não são gravadas de acordo com as práticas recomendadas ou os fluxos de trabalho prontos não são configurados para serem executados da maneira mais eficiente 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 levadas em conta.

Workflows transitórios

Para otimizar cargas altas de assimilação, você pode definir um workflow como transitório.

Quando um workflow é transitó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 persistentes, é claro).

As vantagens podem incluir:

  • Redução do tempo de processamento do workflow; de até 10%.
  • Reduza significativamente o crescimento do repositório.
  • Não é necessário mais workflows CRUD para limpar.
  • Além disso, reduz o número de arquivos TAR a serem compactados.
CUIDADO

Se sua empresa determinar que você persiste/arquiva dados de tempo de execução do fluxo de trabalho para fins de auditoria, não ative esse recurso.

Ajustando fluxos de trabalho do DAM

Para obter as diretrizes de ajuste de desempenho para workflows do DAM, consulte o Guia de Ajuste de Desempenho do AEM Assets.

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

AEM pode permitir que vários threads de workflow 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 são exigentes dos recursos do sistema, isso pode significar que pouco resta para AEM usar em outras tarefas, como renderizar a interface do usuário de criação. Como resultado, o sistema pode ficar lento durante atividades como o upload de imagens em massa.

Para resolver esse problema, o Adobe recomenda configurar o número de Máximo de Trabalhos Paralelos 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 responsivo ao processar esses workflows.

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

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

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

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

Configurar filas de trabalhos individuais

Em alguns casos, é útil configurar filas de trabalhos individuais para controlar encadeamentos simultâneos ou outras opções de fila, com base em um trabalho individual. Você pode adicionar e configurar uma fila individual no console da Web por meio da fábrica Apache Sling Job Queue Configuration. Para encontrar o tópico apropriado para 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 fluxos de trabalho transitórios.

Configurar limpeza de workflow

Numa instalação padrão, o AEM fornece um console de manutenção, onde as 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 de manutenção semanal tem uma tarefa Expurgação do fluxo de trabalho, mas isso precisa ser configurado antes de ser executado. Para configurar limpeza de workflow, um novo Adobe Granite Workflow Purge Configuration deve ser adicionado no console da Web.

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

Personalização

Ao gravar processos de fluxo de trabalho personalizados, alguns itens devem ser considerados.

Localizações

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

OBSERVAÇÃO

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 prontos para uso 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 na instalação de hotfixes, pacotes de correções cumulativas 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 em tempo de execução (integrados 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 do usuário AEM, os detalhes serão copiados para os novos locais.

Locais - Inicializadores do fluxo de trabalho

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

  • Os inicializadores de fluxo de trabalho prontos para uso 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 na instalação de hotfixes, pacotes de correções cumulativas ou service packs.

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

    /conf/global/settings/workflow/launcher/... 
    
  • Os inicializadores de fluxo de trabalho herdados são mantidos no 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 workflow também são armazenados no repositório de acordo com o tipo :

  • Os scripts de workflow prontos para uso 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 na instalação de hotfixes, pacotes de correções cumulativas ou service packs.

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

    /apps/workflow/scripts/... 
    
  • Os scripts de fluxo de trabalho herdados são mantidos no seguinte caminho:

    /etc/workflow/scripts/

Locais - Notificações de fluxo de trabalho

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

  • As definições de notificação de workflow prontas para uso são mantidas no seguinte caminho:

    /libs/settings/workflow/notification/

    CUIDADO

    Não:

    • coloque qualquer uma das 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 na instalação de hotfixes, pacotes de correções cumulativas 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

    Para substituir um texto de notificação de workflow, crie um caminho sobreposto em:

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

  • As definições de notificação de fluxo de trabalho herdadas 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 workflow:

  • Uma sessão de workflow será fornecida e deverá ser usada, a menos que haja um motivo convincente para não fazê-lo.
  • Novas sessões não devem ser criadas a partir de etapas do fluxo de trabalho, pois isso causa inconsistências no(s) estado(s) junto com possíveis problemas de simultaneidade no mecanismo de fluxo de trabalho.
  • 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 workflow fornecida pela API da 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);

Salvar uma sessão:

  • Em um processo de workflow, se o WorkflowSession estiver sendo usado para modificar o repositório e não salvar explicitamente a sessão - o workflow salvará a sessão quando for concluído.

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

    • é recomendável adaptar a sessão jcr do workflow; então save não é necessário, pois o mecanismo de workflow salva a sessão automaticamente após a conclusão da execução do workflow.
    • não é recomendado que uma etapa do processo crie sua própria sessão jcr.
  • Ao eliminar salvamentos desnecessários, é possível reduzir a sobrecarga e, portanto, tornar os workflows mais eficientes.

CUIDADO

Se, apesar das recomendações aqui, você criar sua própria sessão jcr, ela precisará ser salva.

Minimizar o número/escopo de iniciadores

Há um ouvinte que é responsável por todos os iniciadores do workflow que estão registrados:

  • Ele vai acompanhar as alterações em todos os caminhos especificados nas propriedades de globalização dos outros lançadores.
  • Quando um evento é despachado, o mecanismo 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.

Criar um caminho de globalização na raiz do repositório em um único iniciador faria com que o mecanismo de fluxo de trabalho escutasse e avaliasse eventos de criação/modificação em cada nó no repositório. Por esse motivo, é recomendável criar apenas iniciadores necessários e tornar o caminho do globbing o o mais específico possível.

Devido ao impacto desses lançadores 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 do iniciador foi aprimorada para suportar o seguinte:

  • Ter várias condições "AND" juntas.
  • Ter condições OU em uma única condição.
  • Desativar/ativar lançadores com base no fato de um sinalizador de recurso estar ativado ou desativado.
  • Suporte a regex nas condições do iniciador.

Não iniciar fluxos de trabalho de outros fluxos de trabalho

Os workflows podem carregar uma quantidade significativa de sobrecarga, tanto em termos de objetos criados na memória quanto de nós rastreados no repositório. Por isso, é melhor fazer com que um workflow faça seu processamento sozinho em vez de iniciar 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 ativa esse pacote. Em vez de criar o pacote e depois iniciar um fluxo de trabalho separado com o pacote como carga útil, 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 no 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 em suas 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 advance, pois oferece melhor desempenho.

Estágios do fluxo de trabalho

Você pode definir estágios do workflow, em seguida, atribuir tarefas/etapas a um estágio específico do workflow.

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 adição de estágios.

Ativar etapa do processo de página

A etapa Ativar processo de página ativará páginas para você, mas não encontrará automaticamente quaisquer ativos de 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:

  • certifique-se de que qualquer modelo de fluxo de trabalho personalizado tenha backup antes que uma instância seja atualizada.

  • confirme se nenhum de seus workflows personalizados é armazenado no location:

    • /libs/settings/workflow/models/projects
OBSERVAÇÃO

Ferramentas do sistema

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

Console de Manuseio de Trabalho do Sling

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

O console Sling Job Handling mostrará:

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

Ferramenta de relatório de fluxo de trabalho

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

Workflow Maintenance Operations MBean

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

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

Informações adicionais

Para obter mais informações, consulte:

Nesta página