Ampliação da funcionalidade do fluxo de trabalho extending-workflow-functionality
Este tópico descreve como desenvolver componentes de etapa personalizados para seus workflows e, em seguida, como interagir programaticamente com workflows.
A criação de uma etapa de fluxo de trabalho personalizada envolve as seguintes atividades:
- Desenvolva o componente da etapa do fluxo de trabalho.
- Implemente a funcionalidade da etapa como um serviço OSGi ou um script ECMA.
Também é possível interagir com os workflows por meio de programas e scripts.
Componentes da etapa do fluxo de trabalho - Noções básicas workflow-step-components-the-basics
Um componente da etapa do fluxo de trabalho define a aparência e o comportamento da etapa ao criar modelos de fluxo de trabalho:
- A categoria e o nome da etapa no sidekick do fluxo de trabalho.
- A aparência da etapa em modelos de fluxo de trabalho.
- A caixa de diálogo de edição para configurar propriedades do componente.
- O serviço ou script que é executado no tempo de execução.
Assim como com todos os componentes, os componentes da etapa do fluxo de trabalho herdam do componente especificado para a sling:resourceSuperType
propriedade. O diagrama a seguir mostra a hierarquia de cq:component
nós que formam a base de todos os componentes da etapa do fluxo de trabalho. O diagrama também inclui a variável Etapa do processo, Etapa do participante, e Etapa dinâmica do participante componentes, pois esses são os pontos de partida mais comuns (e básicos) para desenvolver componentes de etapa personalizados.
/libs
caminho./libs
é substituído na próxima vez que você atualizar sua instância (e pode ser substituído ao aplicar um hotfix ou pacote de recursos).- Recrie o item necessário (ou seja, como ele existe em
/libs
em/apps
- Fazer alterações em
/apps
A variável /libs/cq/workflow/components/model/step
é o ancestral comum mais próximo do Etapa do processo, Etapa do participante, e Etapa dinâmica do participante, que herdam os seguintes itens:
-
step.jsp
A variável
step.jsp
O script renderiza o título do componente da etapa quando ele é adicionado a um modelo. -
Uma caixa de diálogo com as seguintes guias:
- Comum: para editar o título e a descrição.
- Avançado: para editar propriedades de notificação por email.
note note NOTE Quando as guias da caixa de diálogo de edição de um componente da etapa não corresponderem a essa aparência padrão, o componente da etapa terá scripts definidos, propriedades do nó ou guias de caixa de diálogo que substituem essas guias herdadas.
Scripts ECMA ecma-scripts
Os seguintes objetos estão disponíveis (dependendo do tipo de etapa) nos scripts ECMA:
-
Item de trabalho itemDeTrabalho
-
WorkflowSession workflowSession
-
WorkflowData workflowData
-
args
: matriz com os argumentos do processo. -
sling
: para acessar outros serviços osgi. -
jcrSession
MetaDataMaps metadatamaps
Você pode usar metadados de fluxo de trabalho para manter as informações necessárias durante a vida útil do fluxo de trabalho. Um requisito comum de etapas do fluxo de trabalho é criar dados persistentes para uso futuro no fluxo de trabalho ou recuperar os dados persistentes.
Há três tipos de objetos MetaDataMap - para Workflow
, WorkflowData
e WorkItem
objetos. Todos têm a mesma finalidade: armazenar metadados.
Um item de trabalho tem seu próprio MetaDataMap que só pode ser usado enquanto esse item de trabalho (por exemplo, etapa ) estiver em execução.
Ambos Workflow
e WorkflowData
os metadatamaps são compartilhados em todo o fluxo de trabalho. Nesses casos, é recomendável usar somente o WorkflowData
mapa de metadados.
Criação de componentes de etapa de fluxo de trabalho personalizados creating-custom-workflow-step-components
Os componentes da etapa do fluxo de trabalho podem ser criado da mesma forma que qualquer outro componente.
Para herdar de um dos componentes da etapa base (existentes), adicione a seguinte propriedade à cq:Component
nó:
-
Nome:
sling:resourceSuperType
-
Tipo:
String
-
Valor: um dos seguintes caminhos que são resolvidos para um componente base:
cq/workflow/components/model/process
cq/workflow/components/model/participant
cq/workflow/components/model/dynamic_participant
Especificando o Título e a Descrição Default para Instâncias da Etapa specifying-the-default-title-and-description-for-step-instances
Use o procedimento a seguir para especificar valores default para a variável Título e Descrição campos no Comum guia.
-
A caixa de diálogo de edição da etapa armazena o título e a descrição nos seguintes locais: >
-
./jcr:title
-
./jcr:description
locaisEsse requisito é atendido quando a caixa de diálogo de edição usa a guia Comum que a
/libs/cq/flow/components/step/step
implementações do componente. -
O componente de etapa ou um ancestral do componente não substitui o
step.jsp
script que o/libs/cq/flow/components/step/step
implementações do componente.
-
Abaixo do
cq:Component
adicione o seguinte nó:- Nome:
cq:editConfig
- Tipo:
cq:EditConfig
note note NOTE Para obter mais informações sobre o nó cq:editConfig, consulte Configuração do comportamento de edição de um componente. - Nome:
-
Abaixo do
cq:EditConfig
adicione o seguinte nó:- Nome:
cq:formParameters
- Tipo:
nt:unstructured
- Nome:
-
Adicionar
String
propriedades dos seguintes nomes para ocq:formParameters
nó:jcr:title
: o valor preenche o Título do campo Comum guia.jcr:description
: o valor preenche o Descrição do campo Comum guia.
Salvar valores de propriedade nos metadados de fluxo de trabalho saving-property-values-in-workflow-metadata
A propriedade de nome de cq:Widget
items especifica o nó JCR que armazena o valor do widget. Quando os widgets na caixa de diálogo da etapa do fluxo de trabalho armazenam valores abaixo do ./metaData
, o valor é adicionado ao workflow MetaDataMap
.
Por exemplo, um campo de texto em uma caixa de diálogo é um cq:Widget
que tem as seguintes propriedades:
xtype
String
textarea
name
String
./metaData/subject
fieldLabel
String
Email Subject
O valor especificado nesse campo de texto é adicionado ao da instância do fluxo de trabalho [MetaDataMap](#metadatamaps)
e está associado à variável subject
chave.
PROCESS_ARGS
, o valor estará prontamente disponível nas implementações de script do ECMA por meio do args
variável. Nesse caso, o valor da propriedade name é ./metaData/PROCESS_ARGS.
Substituição da implementação da etapa overriding-the-step-implementation
Cada componente da etapa base permite que os desenvolvedores de modelo de fluxo de trabalho configurem os seguintes recursos principais em tempo de design:
- Etapa do Processo: O serviço ou script ECMA a ser executado no tempo de execução.
- Etapa do participante: a ID do usuário ao qual foi atribuído o item de trabalho gerado.
- Etapa dinâmica do participante: o serviço ou script ECMA que seleciona o ID do usuário atribuído ao item de trabalho.
Para focalizar o componente para uso em um cenário de fluxo de trabalho específico, configure o recurso principal no design e remova a capacidade dos desenvolvedores de modelo de alterá-lo.
-
Abaixo do nó cq:component, adicione o seguinte nó:
- Nome:
cq:editConfig
- Tipo:
cq:EditConfig
Para obter mais informações sobre o nó cq:editConfig, consulte Configuração do comportamento de edição de um componente.
- Nome:
-
Abaixo do nó cq:EditConfig, adicione o seguinte nó:
- Nome:
cq:formParameters
- Tipo:
nt:unstructured
- Nome:
-
Adicionar um
String
para a propriedadecq:formParameters
nó. O supertipo de componente determina o nome da propriedade:- Etapa do processo:
PROCESS
- Etapa do participante:
PARTICIPANT
- Etapa dinâmica do participante:
DYNAMIC_PARTICIPANT
- Etapa do processo:
-
Especifique o valor da propriedade:
PROCESS
: O caminho para o script ECMA ou o PID do serviço que implementa o comportamento da etapa.PARTICIPANT
: a ID do usuário que recebe o item de trabalho.DYNAMIC_PARTICIPANT
: O caminho para o script ECMA ou PID do serviço que seleciona o usuário para atribuir o item de trabalho.
-
Para remover a capacidade dos desenvolvedores de modelo de alterar os valores de propriedade, substitua a caixa de diálogo do supertipo de componente.
Adicionar Forms e caixas de diálogo às etapas do participante adding-forms-and-dialogs-to-participant-steps
Personalize o componente da etapa do participante para fornecer os recursos encontrados na Etapa do participante do formulário e Etapa do participante do diálogo componentes:
- Apresente um formulário ao usuário quando ele abrir o item de trabalho gerado.
- Apresentar uma caixa de diálogo personalizada ao usuário quando ele concluir o item de trabalho gerado.
Execute o procedimento a seguir no novo componente (consulte Criação de componentes de etapa de fluxo de trabalho personalizados):
-
Abaixo do
cq:Component
adicione o seguinte nó:- Nome:
cq:editConfig
- Tipo:
cq:EditConfig
Para obter mais informações sobre o nó cq:editConfig, consulte Configuração do comportamento de edição de um componente.
- Nome:
-
Abaixo do nó cq:EditConfig, adicione o seguinte nó:
- Nome:
cq:formParameters
- Tipo:
nt:unstructured
- Nome:
-
Para apresentar um formulário quando o usuário abrir o item de trabalho, adicione a seguinte propriedade à
cq:formParameters
nó:- Nome:
FORM_PATH
- Tipo:
String
- Valor: o caminho que é resolvido para o formulário
- Nome:
-
Para apresentar uma caixa de diálogo personalizada quando o usuário concluir o item de trabalho, adicione a seguinte propriedade à
cq:formParameters
nó- Nome:
DIALOG_PATH
- Tipo:
String
- Valor: o caminho que é resolvido para a caixa de diálogo
- Nome:
Configurar o comportamento do tempo de execução da etapa do fluxo de trabalho configuring-the-workflow-step-runtime-behavior
Abaixo do cq:Component
nó, adicionar um cq:EditConfig
nó. Abaixo, adicione um nt:unstructured
nó (deve ser nomeado cq:formParameters
) e, nesse nó, adicione as seguintes propriedades:
-
Nome:
PROCESS_AUTO_ADVANCE
-
Tipo:
Boolean
-
Valor:
- quando definido como
true
o fluxo de trabalho executará essa etapa e continuará - isso é padrão e também é recomendado - quando
false
, o fluxo de trabalho será executado e interrompido; isso precisa de manuseio extra, portantotrue
é recomendado
- quando definido como
-
-
Nome:
DO_NOTIFY
- Tipo:
Boolean
- Value: indica se as notificações por email devem ser enviadas para as etapas de participação do usuário (e presume que o servidor de email esteja configurado corretamente)
- Tipo:
Persistência e acesso a dados persisting-and-accessing-data
Dados persistentes para etapas de fluxo de trabalho subsequentes persisting-data-for-subsequent-workflow-steps
Você pode usar metadados de fluxo de trabalho para manter as informações necessárias durante a vida útil do fluxo de trabalho - e entre etapas. Um requisito comum de etapas do fluxo de trabalho é criar dados persistentes para uso futuro ou recuperar os dados persistentes de etapas anteriores.
Os metadados do fluxo de trabalho são armazenados em um MetaDataMap
objeto. A API Java fornece a Workflow.getWorkflowData
método para retornar um WorkflowData
objeto que fornece o MetaDataMap
objeto. Este WorkflowData
MetaDataMap
O objeto está disponível para o serviço OSGi ou para o script ECMA de um componente de etapa.
Java java
O método execute do WorkflowProcess
a implementação é aprovada pelo WorkItem
objeto. Use este objeto para obter as WorkflowData
para a instância de fluxo de trabalho atual. O exemplo a seguir adiciona um item ao workflow MetaDataMap
e, em seguida, registra cada item. O item ("mykey", "My Step Value") está disponível para etapas subsequentes no workflow.
public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {
MetaDataMap wfd = item.getWorkflow().getWorkflowData().getMetaDataMap();
wfd.put("mykey", "My Step Value");
Set<String> keyset = wfd.keySet();
Iterator<String> i = keyset.iterator();
while (i.hasNext()){
Object key = i.next();
log.info("The workflow medata includes key {} and value {}",key.toString(),wfd.get(key).toString());
}
}
Script ECMA ecma-script
A variável graniteWorkItem
é a representação do script ECMA da variável atual WorkItem
Objeto Java. Portanto, você pode usar o graniteWorkItem
para obter os metadados do fluxo de trabalho. O script ECMA a seguir pode ser usado para implementar uma Etapa do processo para adicionar um item ao fluxo de trabalho MetaDataMap
e, em seguida, registre cada item. Esses itens ficam disponíveis nas etapas subsequentes do fluxo de trabalho.
metaData
que está imediatamente disponível para o script da etapa são os metadados da etapa. Os metadados da etapa são diferentes dos metadados do fluxo de trabalho.var currentDateInMillis = new Date().getTime();
graniteWorkItem.getWorkflowData().getMetaDataMap().put("hardcodedKey","theKey");
graniteWorkItem.getWorkflowData().getMetaDataMap().put("currentDateInMillisKey",currentDateInMillis);
var iterator = graniteWorkItem.getWorkflowData().getMetaDataMap().keySet().iterator();
while (iterator.hasNext()){
var key = iterator.next();
log.info("Workflow metadata key, value = " + key.toString() + ", " + graniteWorkItem.getWorkflowData().getMetaDataMap().get(key));
}
Acessando Valores de Propriedade da Caixa de Diálogo no Tempo de Execução accessing-dialog-property-values-at-runtime
A variável MetaDataMap
O objeto de instâncias de fluxo de trabalho é útil para armazenar e recuperar dados durante toda a vida útil do fluxo de trabalho. Para implementações dos componentes da etapa do fluxo de trabalho, a variável MetaDataMap
é especialmente útil para recuperar valores de propriedade de componente no tempo de execução.
O fluxo de trabalho MetaDataMap
O está disponível para implementações de processo de script Java e ECMA:
-
Em implementações Java da interface WorkflowProcess, a variável
args
é o parâmetroMetaDataMap
para o workflow. -
Em implementações de script ECMA, o valor está disponível usando o
args
emetadata
variáveis.
Exemplo: Recuperação de Argumentos do Componente de Etapa do Processo example-retrieving-the-arguments-of-the-process-step-component
A caixa de diálogo de edição do Etapa do processo inclui a variável Argumentos propriedade. O valor de Argumentos propriedade é armazenada nos metadados do fluxo de trabalho e está associada à variável PROCESS_ARGS
chave.
No diagrama a seguir, o valor de Argumentos propriedade é argument1, argument2
:
Java java-1
O código Java a seguir é o execute
para um WorkflowProcess
execução. O método registra o valor na variável args
MetaDataMap
que está associado à variável PROCESS_ARGS
chave.
public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {
if (args.containsKey("PROCESS_ARGS")){
log.info("workflow metadata for key PROCESS_ARGS and value {}",args.get("PROCESS_ARGS","string").toString());
}
}
Quando uma etapa do processo que usa essa implementação Java é executada, o log contém a seguinte entrada:
16.02.2018 12:07:39.566 *INFO* [JobHandler: /var/workflow/instances/server0/2018-02-16/model_855140139900189:/content/we-retail/de] com.adobe.example.workflow.impl.process.LogArguments workflow metadata for key PROCESS_ARGS and value argument1, argument2
Script ECMA ecma-script-1
O script ECMA a seguir é usado como o processo para o Etapa do processo. Ele registra o número de argumentos e os valores do argumento:
var iterator = graniteWorkItem.getWorkflowData().getMetaDataMap().keySet().iterator();
while (iterator.hasNext()){
var key = iterator.next();
log.info("Workflow metadata key, value = " + key.toString() + ", " + graniteWorkItem.getWorkflowData().getMetaDataMap().get(key));
}
log.info("hardcodedKey "+ graniteWorkItem.getWorkflowData().getMetaDataMap().get("hardcodedKey"));
log.info("currentDateInMillisKey "+ graniteWorkItem.getWorkflowData().getMetaDataMap().get("currentDateInMillisKey"));
Scripts e Argumentos do Processo scripts-and-process-arguments
Em um script para um Etapa do processo , os argumentos estão disponíveis por meio da args
objeto.
Ao criar um componente de etapa personalizado, o objeto metaData
está disponível em um script. Esse objeto é limitado a um único argumento de string.
Desenvolvimento de implementações de etapas do processo developing-process-step-implementations
Quando as etapas do processo são iniciadas durante o processo de um workflow, as etapas enviam uma solicitação para um serviço OSGi ou executam um script ECMA. Desenvolva o serviço ou script ECMA que executa as ações exigidas pelo seu fluxo de trabalho.
Implementando uma etapa do processo com uma classe Java implementing-a-process-step-with-a-java-class
Para definir uma etapa do processo como um componente de serviço OSGI (pacote Java):
-
Crie o pacote e implante-o no contêiner OSGI. Consulte a documentação sobre a criação de um pacote com o CRXDE Lite ou Eclipse.
note note NOTE O componente OSGI precisa implementar o WorkflowProcess
com seuexecute()
método. Consulte o código de exemplo abaixo.note note NOTE O nome do pacote precisa ser adicionado à variável <*Private-Package*>
seção domaven-bundle-plugin
configuração. -
Adicionar a propriedade SCR
process.label
e defina o valor conforme necessário. Esse será o nome com o qual a etapa do processo é listada ao usar o parâmetro Etapa do processo componente. Veja o exemplo abaixo. -
No Modelos editor, adicione a etapa do processo ao fluxo de trabalho usando o método Etapa do processo componente.
-
Na caixa de diálogo de edição (da Etapa do processo), vá para a guia Processo e selecione a implementação do processo.
-
Se você usar argumentos em seu código, defina a variável Argumentos do processo. Por exemplo: falso.
-
Salve as alterações para a etapa e o modelo de fluxo de trabalho (canto superior esquerdo do editor de modelo).
Os métodos java, respectivamente, as classes que implementam o método Java executável são registrados como serviços OSGI, permitindo que você adicione métodos a qualquer momento durante o tempo de execução.
O seguinte componente OSGI adiciona a propriedade approved
ao nó de conteúdo da página quando a carga é uma página:
package com.adobe.example.workflow.impl.process;
import com.adobe.granite.workflow.WorkflowException;
import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.WorkItem;
import com.adobe.granite.workflow.exec.WorkflowData;
import com.adobe.granite.workflow.exec.WorkflowProcess;
import com.adobe.granite.workflow.metadata.MetaDataMap;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.osgi.framework.Constants;
import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
/**
* Sample workflow process that sets an <code>approve</code> property to the payload based on the process argument value.
*/
@Component
@Service
public class MyProcess implements WorkflowProcess {
@Property(value = "An example workflow process implementation.")
static final String DESCRIPTION = Constants.SERVICE_DESCRIPTION;
@Property(value = "Adobe")
static final String VENDOR = Constants.SERVICE_VENDOR;
@Property(value = "My Sample Workflow Process")
static final String LABEL="process.label";
private static final String TYPE_JCR_PATH = "JCR_PATH";
public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {
WorkflowData workflowData = item.getWorkflowData();
if (workflowData.getPayloadType().equals(TYPE_JCR_PATH)) {
String path = workflowData.getPayload().toString() + "/jcr:content";
try {
Session jcrSession = session.adaptTo(Session.class);
Node node = (Node) jcrSession.getItem(path);
if (node != null) {
node.setProperty("approved", readArgument(args));
jcrSession.save();
}
} catch (RepositoryException e) {
throw new WorkflowException(e.getMessage(), e);
}
}
}
private boolean readArgument(MetaDataMap args) {
String argument = args.get("PROCESS_ARGS", "false");
return argument.equalsIgnoreCase("true");
}
}
Utilização do ECMAScript using-ecmascript
Os scripts ECMA permitem que os desenvolvedores de script implementem etapas de processo. Os scripts estão no repositório JCR e são executados nele.
A tabela a seguir lista as variáveis que estão imediatamente disponíveis para processar scripts, fornecendo acesso aos objetos da API Java do workflow.
com.adobe.granite.workflow.exec.WorkItem
graniteWorkItem
com.adobe.granite.workflow.WorkflowSession
graniteWorkflowSession
String[]
(contém argumentos de processo)args
com.adobe.granite.workflow.metadata.MetaDataMap
metaData
org.apache.sling.scripting.core.impl.InternalScriptHelper
sling
O exemplo de script a seguir demonstra como acessar o nó JCR que representa a carga do fluxo de trabalho. A variável graniteWorkflowSession
é adaptada a uma variável de sessão JCR, que é usada para obter o nó do caminho da carga.
var workflowData = graniteWorkItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH") {
var path = workflowData.getPayload().toString();
var jcrsession = graniteWorkflowSession.adaptTo(Packages.javax.jcr.Session);
var node = jcrsession.getNode(path);
if (node.hasProperty("approved")){
node.setProperty("approved", args[0] == "true" ? true : false);
node.save();
}
}
O script a seguir verifica se o conteúdo é uma imagem ( .png
), cria uma imagem em preto-e-branco a partir dela e a salva como um nó irmão.
var workflowData = graniteWorkItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH") {
var path = workflowData.getPayload().toString();
var jcrsession = graniteWorkflowSession.adaptTo(Packages.javax.jcr.Session);
var node = jcrsession.getRootNode().getNode(path.substring(1));
if (node.isNodeType("nt:file") && node.getProperty("jcr:content/jcr:mimeType").getString().indexOf("image/") == 0) {
var is = node.getProperty("jcr:content/jcr:data").getStream();
var layer = new Packages.com.day.image.Layer(is);
layer.grayscale();
var parent = node.getParent();
var gn = parent.addNode("grey" + node.getName(), "nt:file");
var content = gn.addNode("jcr:content", "nt:resource");
content.setProperty("jcr:mimeType","image/png");
var cal = Packages.java.util.Calendar.getInstance();
content.setProperty("jcr:lastModified",cal);
var f = Packages.java.io.File.createTempFile("test",".png");
var tout = new Packages.java.io.FileOutputStream(f);
layer.write("image/png", 1.0, tout);
var fis = new Packages.java.io.FileInputStream(f);
content.setProperty("jcr:data", fis);
parent.save();
tout.close();
fis.close();
is.close();
f.deleteOnExit();
}
}
Para usar o script:
-
Crie o script (por exemplo, com CRXDE Lite) e salve-o no repositório abaixo
//apps/workflow/scripts/
-
Para especificar um título que identifique o script na variável Etapa do processo caixa de diálogo de edição, adicione as seguintes propriedades à
jcr:content
nó do script:table 0-row-3 1-row-3 2-row-3 Nome Tipo Valor jcr:mixinTypes
Name[]
mix:title
jcr:title
String
O nome a ser exibido na caixa de diálogo de edição. -
Edite o Etapa do processo e especifique o script a ser usado.
Desenvolvendo seletores de participantes developing-participant-choosers
Você pode desenvolver seletores de participantes para Etapa dinâmica do participante componentes.
Quando um Etapa dinâmica do participante for iniciado durante um fluxo de trabalho, a etapa precisará determinar o participante ao qual o item de trabalho gerado pode ser atribuído. Para fazer isso, siga um destes procedimentos:
- envia uma solicitação a um serviço OSGi
- executa um script ECMA para selecionar o participante
Você pode desenvolver um serviço ou script ECMA que selecione o participante de acordo com os requisitos do seu fluxo de trabalho.
Desenvolvendo um seletor de participantes usando uma classe Java developing-a-participant-chooser-using-a-java-class
Para definir uma etapa do participante como um componente de serviço OSGI (classe Java):
-
O componente OSGI precisa implementar o
ParticipantStepChooser
com seugetParticipant()
método. Consulte o código de exemplo abaixo.Crie o pacote e implante-o no contêiner OSGI.
-
Adicionar a propriedade SCR
chooser.label
e defina o valor conforme necessário. Esse será o nome com o qual o seletor de participantes será listado, usando o Etapa dinâmica do participante componente. Veja o exemplo:code language-java package com.adobe.example.workflow.impl.process; import com.adobe.granite.workflow.WorkflowException; import com.adobe.granite.workflow.WorkflowSession; import com.adobe.granite.workflow.exec.ParticipantStepChooser; import com.adobe.granite.workflow.exec.WorkItem; import com.adobe.granite.workflow.exec.WorkflowData; import com.adobe.granite.workflow.metadata.MetaDataMap; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Property; import org.apache.felix.scr.annotations.Service; import org.osgi.framework.Constants; /** * Sample dynamic participant step that determines the participant based on a path given as argument. */ @Component @Service public class MyDynamicParticipant implements ParticipantStepChooser { @Property(value = "An example implementation of a dynamic participant chooser.") static final String DESCRIPTION = Constants.SERVICE_DESCRIPTION; @Property(value = "Adobe") static final String VENDOR = Constants.SERVICE_VENDOR; @Property(value = "Dynamic Participant Chooser Process") static final String LABEL=ParticipantStepChooser.SERVICE_PROPERTY_LABEL; private static final String TYPE_JCR_PATH = "JCR_PATH"; public String getParticipant(WorkItem workItem, WorkflowSession workflowSession, MetaDataMap args) throws WorkflowException { WorkflowData workflowData = workItem.getWorkflowData(); if (workflowData.getPayloadType().equals(TYPE_JCR_PATH)) { String path = workflowData.getPayload().toString(); String pathFromArgument = args.get("PROCESS_ARGS", String.class); if (pathFromArgument != null && path.startsWith(pathFromArgument)) { return "admin"; } } return "administrators"; } }
-
No Modelos editor, adicione a etapa de participante dinâmico ao fluxo de trabalho usando o Etapa dinâmica do participante componente.
-
Na caixa de diálogo de edição, selecione o Seletor de participantes e selecione a implementação do seletor.
-
Se você usar argumentos no seu código, defina o Argumentos do processo. Para este exemplo:
/content/we-retail/de
. -
Salve as alterações para a etapa e o modelo de fluxo de trabalho.
Desenvolvendo um seletor de participantes usando um script ECMA developing-a-participant-chooser-using-an-ecma-script
Você pode criar um script ECMA que selecione o usuário atribuído ao item de trabalho que o Etapa do participante gera. O script deve incluir uma função chamada getParticipant
que não requer argumentos e retorna um String
que contém a ID de um usuário ou grupo.
Os scripts estão no repositório JCR e são executados nele.
A tabela a seguir lista as variáveis que fornecem acesso imediato aos objetos Java do workflow nos scripts.
com.adobe.granite.workflow.exec.WorkItem
graniteWorkItem
com.adobe.granite.workflow.WorkflowSession
graniteWorkflowSession
String[]
(contém argumentos de processo)args
com.adobe.granite.workflow.metadata.MetaDataMap
metaData
org.apache.sling.scripting.core.impl.InternalScriptHelper
sling
function getParticipant() {
var workflowData = graniteWorkItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH") {
var path = workflowData.getPayload().toString();
if (path.indexOf("/content/we-retail/de") == 0) {
return "admin";
} else {
return "administrators";
}
}
}
-
Crie o script (por exemplo, com CRXDE Lite) e salve-o no repositório abaixo
//apps/workflow/scripts
-
Para especificar um título que identifique o script na variável Etapa do processo caixa de diálogo de edição, adicione as seguintes propriedades à
jcr:content
nó do script:table 0-row-3 1-row-3 2-row-3 Nome Tipo Valor jcr:mixinTypes
Name[]
mix:title
jcr:title
String
O nome a ser exibido na caixa de diálogo de edição. -
Edite o Etapa dinâmica do participante e especifique o script a ser usado.
Lidar com pacotes de fluxo de trabalho handling-workflow-packages
Pacotes de fluxo de trabalho pode ser passado para um workflow para processamento. Os pacotes de fluxo de trabalho contêm referências a recursos como páginas e ativos.
Você pode desenvolver etapas de fluxo de trabalho que obtêm os recursos do pacote e os processam. Os seguintes membros da com.day.cq.workflow.collection
fornecem acesso a pacotes de fluxo de trabalho:
ResourceCollection
: classe do pacote de fluxo de trabalho.ResourceCollectionUtil
: use para recuperar objetos ResourceCollection.ResourceCollectionManager
: cria e recupera coleções. Uma implementação é implantada como um serviço OSGi.
O exemplo de classe Java a seguir demonstra como obter recursos de pacote:
package com.adobe.example;
import java.util.ArrayList;
import java.util.List;
import com.day.cq.workflow.WorkflowException;
import com.day.cq.workflow.WorkflowSession;
import com.day.cq.workflow.collection.ResourceCollection;
import com.day.cq.workflow.collection.ResourceCollectionManager;
import com.day.cq.workflow.collection.ResourceCollectionUtil;
import com.day.cq.workflow.exec.WorkItem;
import com.day.cq.workflow.exec.WorkflowData;
import com.day.cq.workflow.exec.WorkflowProcess;
import com.day.cq.workflow.metadata.MetaDataMap;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.Reference;
import org.osgi.framework.Constants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.jcr.Node;
import javax.jcr.PathNotFoundException;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
@Component
@Service
public class LaunchBulkActivate implements WorkflowProcess {
private static final Logger log = LoggerFactory.getLogger(LaunchBulkActivate.class);
@Property(value="Bulk Activate for Launches")
static final String PROCESS_NAME ="process.label";
@Property(value="A sample workflow process step to support Launches bulk activation of pages")
static final String SERVICE_DESCRIPTION = Constants.SERVICE_DESCRIPTION;
@Reference
private ResourceCollectionManager rcManager;
public void execute(WorkItem workItem, WorkflowSession workflowSession) throws Exception {
Session session = workflowSession.getSession();
WorkflowData data = workItem.getWorkflowData();
String path = null;
String type = data.getPayloadType();
if (type.equals(TYPE_JCR_PATH) && data.getPayload() != null) {
String payloadData = (String) data.getPayload();
if (session.itemExists(payloadData)) {
path = payloadData;
}
} else if (data.getPayload() != null && type.equals(TYPE_JCR_UUID)) {
Node node = session.getNodeByUUID((String) data.getPayload());
path = node.getPath();
}
// CUSTOMIZED CODE IF REQUIRED....
if (path != null) {
// check for resource collection
ResourceCollection rcCollection = ResourceCollectionUtil.getResourceCollection((Node)session.getItem(path), rcManager);
// get list of paths to replicate (no resource collection: size == 1
// otherwise size >= 1
List<String> paths = getPaths(path, rcCollection);
for (String aPath: paths) {
// CUSTOMIZED CODE....
}
} else {
log.warn("Cannot process because path is null for this " + "workitem: " + workItem.toString());
}
}
/**
* helper
*/
private List<String> getPaths(String path, ResourceCollection rcCollection) {
List<String> paths = new ArrayList<String>();
if (rcCollection == null) {
paths.add(path);
} else {
log.debug("ResourceCollection detected " + rcCollection.getPath());
// this is a resource collection. the collection itself is not
// replicated. only its members
try {
List<Node> members = rcCollection.list(new String[]{"cq:Page", "dam:Asset"});
for (Node member: members) {
String mPath = member.getPath();
paths.add(mPath);
}
} catch(RepositoryException re) {
log.error("Cannot build path list out of the resource collection " + rcCollection.getPath());
}
}
return paths;
}
}
Exemplo: Criação de uma etapa personalizada example-creating-a-custom-step
Uma maneira fácil de começar a criar sua própria etapa personalizada é copiar uma etapa existente do:
/libs/cq/workflow/components/model
Criação da etapa básica creating-the-basic-step
-
Recrie o caminho em /apps; por exemplo:
/apps/cq/workflow/components/model
As novas pastas são do tipo
nt:folder
:code language-xml - apps - cq - workflow (nt:folder) - components (nt:folder) - model (nt:folder)
note note NOTE Esta etapa não se aplica ao editor de modelo de interface clássica. -
Em seguida, coloque a etapa copiada na pasta /apps; por exemplo, como:
/apps/cq/workflow/components/model/myCustomStep
Este é o resultado de nosso exemplo de etapa personalizada:
note caution CAUTION Como na interface do usuário padrão, somente o título e não os detalhes não são exibidos no cartão, details.jsp
não é necessário, pois era para o editor de interface clássica. -
Aplique as seguintes propriedades ao nó:
/apps/cq/workflow/components/model/myCustomStep
Propriedades de interesse:
-
sling:resourceSuperType
Deve herdar de uma etapa existente.
Neste exemplo, estamos herdando da etapa base em
cq/workflow/components/model/step
, mas você pode usar outros supertipos comoparticipant
,process
e assim por diante. -
jcr:title
É o título exibido quando o componente é listado no navegador de etapas (painel lateral esquerdo do editor de modelo de fluxo de trabalho).
-
cq:icon
Usado para especificar um Ícone do Coral para a etapa.
-
componentGroup
Deve ser um dos seguintes:
- Fluxo de trabalho de colaboração
- Fluxo de trabalho DAM
- Fluxo de trabalho dos formulários
- Projetos
- WCM fluxo de trabalho
- Fluxo de trabalho
-
-
Agora é possível abrir um modelo de fluxo de trabalho para edição. No navegador de etapas, é possível filtrar para ver Minha etapa personalizada:
Arrastando Minha etapa personalizada no modelo exibe o cartão:
Se não
cq:icon
for definida para a etapa, um ícone padrão será renderizado usando as duas primeiras letras do título. Por exemplo:
Definir a caixa de diálogo Configurar etapa defining-the-step-configure-dialog
Depois Criação da etapa básica, defina a etapa Configurar da seguinte forma:
-
Configurar as propriedades no nó
cq:editConfig
do seguinte modo:Propriedades de interesse:
-
cq:inherit
Quando definido como
true
, o componente de etapa herdará as propriedades da etapa especificada emsling:resourceSuperType
. -
cq:disableTargeting
Defina conforme necessário.
-
-
Configurar as propriedades no nó
cq:formsParameter
do seguinte modo:Propriedades de interesse:
-
jcr:title
Define o título padrão no cartão de etapa no mapa do modelo e na variável Título do campo Meu personalizado - Propriedades da etapa caixa de diálogo de configuração.
-
Você também pode definir suas próprias propriedades personalizadas.
-
-
Configurar as propriedades no nó
cq:listeners
.A variável
cq:listener
O nó e suas propriedades permitem definir manipuladores de eventos que reagem a eventos no editor de modelo de interface habilitada para toque; como arrastar uma etapa para uma página de modelo ou editar propriedades de uma etapa.Propriedades de interesse:
afterMove: REFRESH_PAGE
afterdelete: CQ.workflow.flow.Step.afterDelete
afteredit: CQ.workflow.flow.Step.afterEdit
afterinsert: CQ.workflow.flow.Step.afterInsert
Essa configuração é essencial para o funcionamento adequado do editor. Na maioria dos casos, essa configuração não deve ser alterada.
No entanto, definindo
cq:inherit
para verdadeiro (nocq:editConfig
) permite herdar essa configuração, sem precisar incluí-la explicitamente na definição da etapa. Se nenhuma herança estiver em vigor, será necessário adicionar esse nó com as seguintes propriedades e valores.Neste exemplo, a herança foi ativada para que pudéssemos remover a
cq:listeners
e a etapa ainda funcionará corretamente. -
Agora é possível adicionar uma instância da etapa a um modelo de fluxo de trabalho. Quando você Configurar a etapa em que você verá a caixa de diálogo:
Exemplo de marcação usada neste exemplo sample-markup-used-in-this-example
A marcação para uma etapa personalizada deve ser representada na .content.xml
do nó raiz do componente. A amostra .content.xml
usado para este exemplo:
/apps/cq/workflow/components/model/myCustomStep/.content.xml
<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
cq:icon="bell"
jcr:primaryType="cq:Component"
jcr:title="My Custom Step"
sling:resourceSuperType="cq/workflow/components/model/process"
allowedParents="[*/parsys]"
componentGroup="Workflow"/>
A variável _cq_editConfig.xml
exemplo usado neste exemplo:
<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
cq:disableTargeting="{Boolean}true"
cq:inherit="{Boolean}true"
jcr:primaryType="cq:EditConfig">
<cq:formParameters
jcr:primaryType="nt:unstructured"
jcr:title="My Custom Step Card"
SAMPLE_PROPERY="sample value"/>
<cq:listeners
jcr:primaryType="cq:EditListenersConfig"
afterdelete="CQ.workflow.flow.Step.afterDelete"
afteredit="CQ.workflow.flow.Step.afterEdit"
afterinsert="CQ.workflow.flow.Step.afterInsert"
afterMove="REFRESH_PAGE"/>
</jcr:root>
A variável _cq_dialog/.content.xml
exemplo usado neste exemplo:
<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
jcr:primaryType="nt:unstructured"
jcr:title="My Custom - Step Properties"
sling:resourceType="cq/gui/components/authoring/dialog">
<content
jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/coral/foundation/tabs">
<items jcr:primaryType="nt:unstructured">
<common
cq:hideOnEdit="true"
jcr:primaryType="nt:unstructured"
jcr:title="Common"
sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns"/>
<process
cq:hideOnEdit="true"
jcr:primaryType="nt:unstructured"
jcr:title="Process"
sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns"/>
<mycommon
jcr:primaryType="nt:unstructured"
jcr:title="Common"
sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
<items jcr:primaryType="nt:unstructured">
<columns
jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/coral/foundation/container">
<items jcr:primaryType="nt:unstructured">
<title
jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/coral/foundation/form/textfield"
fieldLabel="Title"
name="./jcr:title"/>
<description
jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/coral/foundation/form/textarea"
fieldLabel="Description"
name="./jcr:description"/>
</items>
</columns>
</items>
</mycommon>
<advanced
jcr:primaryType="nt:unstructured"
jcr:title="Advanced"
sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
<items jcr:primaryType="nt:unstructured">
<columns
jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/coral/foundation/container">
<items jcr:primaryType="nt:unstructured">
<email
jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/coral/foundation/form/checkbox"
fieldDescription="Notify user via email."
fieldLabel="Email"
name="./metaData/PROCESS_AUTO_ADVANCE"
text="Notify user via email."
value="true"/>
</items>
</columns>
</items>
</advanced>
</items>
</content>
</jcr:root>
sling:resourceSuperType : cq/workflow/components/model/process
-
Nos casos em que uma caixa de diálogo atualizada está vazia, você pode consultar as caixas de diálogo em
/libs
que têm funcionalidade semelhante a exemplos de como fornecer uma solução. Por exemplo: -
/libs/cq/workflow/components/model
-
/libs/cq/workflow/components/workflow
-
/libs/dam/components
-
/libs/wcm/workflow/components/autoassign
-
/libs/cq/projects
Não editar nada no
/libs
, basta usá-los como exemplos. Se quiser usar qualquer uma das etapas existentes, copie-as para/apps
e editá-los lá.