Variáveis em fluxos de trabalho AEM centrados no Forms variables-in-aem-forms-workflows

Uma variável em um modelo de fluxo de trabalho é uma maneira de armazenar um valor com base em seu tipo de dados. É possível usar o nome da variável em qualquer etapa do fluxo de trabalho para recuperar o valor armazenado na variável. Você também pode usar nomes de variáveis para definir expressões para tomar decisões de roteamento.

Em modelos de fluxo de trabalho do AEM, é possível:

O vídeo a seguir demonstra como criar, definir e usar variáveis em modelos de fluxo de trabalho do AEM:

As variáveis são uma extensão da interface MetaDataMap existente. Você pode usar MetaDataMap no ECMAScript para acessar metadados salvos usando variáveis.

Criar uma variável create-a-variable

Você cria variáveis usando a seção Variáveis disponível no sidekick do modelo de fluxo de trabalho. As variáveis de fluxo de trabalho do AEM são compatíveis com os seguintes tipos de dados:

Use o tipo de dados ArrayList para criar coleções de variáveis. Você pode criar uma variável ArrayList para todos os tipos de dados primitivos e complexos. Por exemplo, crie uma variável ArrayList e selecione String como subtipo para armazenar vários valores de string usando a variável.

Para criar uma variável:

Ao criar variáveis, considere as seguintes práticas:

Definir uma variável set-a-variable

Você pode usar a etapa Definir variável para definir o valor de uma variável e a ordem na qual os valores são definidos. A variável é definida na ordem em que os mapeamentos de variável são listados na etapa Definir variável.

As alterações nos valores da variável afetam somente a instância do processo na qual a alteração ocorre. Por exemplo, quando um workflow é iniciado e os dados variáveis são alterados, as alterações afetam somente essa instância do workflow. As alterações não afetam outras instâncias do fluxo de trabalho que foram iniciadas anteriormente ou são iniciadas posteriormente.

Dependendo do tipo de dados da variável, você pode usar as seguintes opções para definir o valor de uma variável:

Você também pode atualizar elementos específicos de uma variável do tipo JSON ou XML usando a notação JSON DOT ou XPATH.

Adicionar mapeamento entre variáveis add-mapping-between-variables

Para adicionar mapeamento entre variáveis:

Exemplo 1: consultar uma variável XML para definir o valor de uma variável de string example-query-an-xml-variable-to-set-value-for-a-string-variable

Selecione uma variável do tipo XML para armazenar um arquivo XML. Consulte a variável XML para definir o valor de uma variável de string para a propriedade disponível no arquivo XML. Use Especificar XPATH para o campo de variável XML para definir a propriedade a ser armazenada na variável de cadeia de caracteres.

Neste exemplo, selecione uma variável XML formdata para armazenar o arquivo cc-app.xml. Consulte a variável formdata para definir o valor da variável de cadeia de caracteres emailaddress e armazenar o valor da propriedade emailAddress disponível no arquivo cc-app.xml.

Exemplo 2: usar uma expressão para armazenar valor com base em outras variáveis example2

Use uma expressão para calcular a soma das variáveis e armazenar o resultado em uma variável.

Neste exemplo, use o editor de expressão para definir uma expressão para calcular a soma das variáveis assetscost e balanceamount e armazenar o resultado na variável totalvalue.

Usar editor de expressão use-expression-editor

Também é possível usar expressões para calcular o valor de uma variável no tempo de execução. As variáveis fornecem um editor de expressão para definir expressões.

Use o editor de expressão para:

Tem como base o editor de regras do Adaptive Forms com as seguintes alterações. Editor de regras em variáveis:

Para obter mais informações, consulte Editor de regras do Adaptive Forms.

Usar uma variável use-a-variable

Você pode usar variáveis para recuperar entradas e saídas ou salvar o resultado de uma etapa. O editor de workflow fornece dois tipos de etapas de workflow:

Etapas do fluxo de trabalho com suporte para variáveis workflow-steps-with-support-for-variables

A etapa Ir para, OU a etapa Dividir, e todas as etapas do fluxo de trabalho AEM Forms oferecem suporte a variáveis.

OU Etapa de divisão or-split-step

A divisão OR cria uma divisão no fluxo de trabalho, depois da qual apenas uma ramificação fica ativa. Essa etapa permite introduzir caminhos de processamento condicional no fluxo de trabalho. Adicione etapas do fluxo de trabalho a cada ramificação, conforme necessário.

Você pode definir a expressão de roteamento para uma ramificação usando uma definição de regra, um script ECMA ou um script externo.

Você pode usar variáveis para definir a expressão de roteamento usando o editor de expressão. Para obter mais informações sobre como usar expressões de roteamento para a etapa de Divisão OR, consulte OU Etapa de divisão.

Neste exemplo, antes de definir a expressão de roteamento, use o exemplo 2 para definir o valor da variável totalvalue. A ramificação 1 estará ativa se o valor da variável totalvalue for maior que 50000. Da mesma forma, é possível definir uma regra para tornar a Ramificação 2 ativa se o valor da variável totalvalue for menor que 50000.

Da mesma forma, selecione um caminho de script externo ou especifique o script ECMA para expressões de roteamento para avaliar a ramificação ativa. Selecione Renomear ramificação para especificar um nome alternativo para a ramificação.

Etapa Ir para go-to-step

A Etapa Ir para permite que você especifique a próxima etapa no modelo de fluxo de trabalho a ser executada, dependendo do resultado de uma expressão de roteamento.

Semelhante à etapa OU Split, você pode definir a expressão de roteamento para a etapa Ir para usando uma definição de regra, um script ECMA ou um script externo.

Você pode usar variáveis para definir a expressão de roteamento usando o editor de expressão. Para obter mais informações sobre o uso de expressões de roteamento para a etapa Ir para, consulte Etapa Ir para.

Neste exemplo, a etapa Ir para especifica Revisar Aplicativo de Cartão de Crédito como a próxima etapa se o valor da variável actiontaken for igual a Need more info.

Para obter mais exemplos sobre como usar a definição de regra na etapa Ir para, consulte Simulando um loop For.

Etapas de fluxo de trabalho centradas na Forms forms-workflow-centric-workflow-steps

Todas as etapas do fluxo de trabalho AEM Forms oferecem suporte a variáveis. Para obter mais informações, consulte Fluxo de trabalho centrado no Forms no OSGi.

Etapas de fluxo de trabalho sem suporte para variáveis workflow-steps-without-support-for-variables

Você pode usar a interface MetaDataMap para acessar variáveis em etapas de fluxo de trabalho que não oferecem suporte a variáveis.

Recuperar o valor da variável retrieve-the-variable-value

Use as seguintes APIs no Script ECMA para recuperar valores para variáveis existentes com base no tipo de dados:

Exemplo

Recupere o valor do tipo de dados string usando a seguinte API:

workItem.getWorkflowData().getMetaDataMap().get(accname, Packages.java.lang.String)

Atualizar o valor da variável update-the-variable-value

Use a seguinte API no Script ECMA para atualizar o valor de uma variável:

workItem.getWorkflowData().getMetaDataMap().put(variableName, value)

Exemplo

workItem.getWorkflowData().getMetaDataMap().put(salary, 50000)

Atualiza o valor da variável salário para 50000.

Definir variáveis para chamar workflows apiinvokeworkflow

Você pode usar uma API para definir variáveis e passá-las para chamar instâncias de fluxo de trabalho.

workflowSession.startWorkflow usa model, wfData e metaData como argumentos. Use MetaDataMap para definir o valor da variável.

Nesta API, a variável variableName está definida como value usando metaData.put(variableName, value);

import com.adobe.granite.workflow.model.WorkflowModel;
import com.adobe.granite.workflow.metadata.MetaDataMap;
import com.adobe.aemfd.docmanager.Document;

/*Assume that you already have a workflowSession and modelId along with the payloadType and payload*/
WorkflowData wfData = workflowSession.newWorkflowData(payloadType, payload);
MetaDataMap metaData = wfData.getMetaDataMap();
metaData.put(variableName, value); //Create a variable "variableName" in your workflow model
WorkflowModel model = workflowSession.getModel(modelId);
workflowSession.startWorkflow(model, wfData, metaData);

Exemplo

Inicialize o objeto de documento doc em um caminho ("a/b/c") e defina o valor da variável docVar para o caminho armazenado no objeto de documento.

import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.WorkflowData;
import com.adobe.granite.workflow.model.WorkflowModel;
import com.adobe.granite.workflow.metadata.MetaDataMap;
import com.adobe.aemfd.docmanager.Document;

/*This example assumes that you already have a workflowSession and modelId along with the payloadType and payload */
WorkflowData wfData = workflowSession.newWorkflowData(payloadType, payload);
MetaDataMap metaData = wfData.getMetaDataMap();
Document doc = new Document("/a/b/c");// initialize a document object
metaData.put("docVar",doc); //Assuming that you have created a variable "docVar" of type Document in your workflow model
WorkflowModel model = workflowSession.getModel(modelId);
workflowSession.startWorkflow(model, wfData, metaData);

Editar uma variável edit-a-variable

Excluir uma variável delete-a-variable

Antes de excluir a variável, remova todas as referências da variável do fluxo de trabalho. Verifique se a variável não está sendo usada no fluxo de trabalho.

Para excluir uma variável:

Referências references

Para obter mais exemplos sobre como usar variáveis nas etapas do fluxo de trabalho AEM Forms, consulte Variáveis em fluxos de trabalho AEM.