Show Menu
TÓPICOS×

Chamada de um fluxo de trabalho com parâmetros externos

O Campaign Standard permite que você chame um fluxo de trabalho com parâmetros (um nome de público-alvo a ser direcionado, um nome de arquivo a ser importado, uma parte do conteúdo da mensagem etc.). Dessa forma, você pode integrar facilmente suas automações do Campaign ao seu sistema externo.
Vejamos o exemplo a seguir, no qual queremos enviar emails diretamente de um CMS. Nesse caso, você pode configurar seu sistema para selecionar o público-alvo e enviar conteúdo por email para o CMS. Clicar em Enviar chamará um fluxo de trabalho de Campanha com esses parâmetros, permitindo que você os use no fluxo de trabalho para definir o público-alvo e o conteúdo do URL a serem usados na entrega.
O processo para chamar um fluxo de trabalho com parâmetros é o seguinte:
  1. Declarar os parâmetros na External signal atividade. Consulte Declaração dos parâmetros na atividade de sinal externo.
  2. Configure a End atividade ou a chamada da API para definir os parâmetros e acionar a External signal atividade do fluxo de trabalho.
Depois que o fluxo de trabalho é acionado, os parâmetros são ingeridos nas variáveis de eventos do fluxo de trabalho e podem ser usados no fluxo de trabalho. Consulte Personalizar um fluxo de trabalho com parâmetros externos.

Declaração dos parâmetros na atividade de sinal externo

A primeira etapa para chamar um fluxo de trabalho com parâmetros é declará-los em uma External signal atividade.
  1. Abra a External signal atividade e selecione a Parameters guia.
  2. Clique no Create element botão e especifique o nome e o tipo de cada parâmetro.
    Certifique-se de que o nome e o número de parâmetros sejam idênticos ao definido ao chamar o fluxo de trabalho (consulte Definição dos parâmetros ao chamar o fluxo de trabalho ). Além disso, os tipos de parâmetros devem ser compatíveis com os valores esperados.
  3. Depois que os parâmetros forem declarados, conclua a configuração do fluxo de trabalho e execute-a.

Definição dos parâmetros ao chamar o fluxo de trabalho

Esta seção detalha como definir parâmetros ao chamar um fluxo de trabalho. Para obter mais informações sobre como executar essa operação a partir de uma chamada de API, consulte a documentação Acionando uma atividade de sinal REST APIs.
Antes de definir os parâmetros, verifique se:
Para configurar a End atividade, siga as etapas abaixo:
  1. Abra a End atividade e selecione a External signal guia.
  2. Selecione o fluxo de trabalho e a atividade do sinal externo que você deseja chamar.
  3. Clique no Create element botão para adicionar um parâmetro e preencha seu nome e valor.
    Verifique se todos os parâmetros foram declarados na External signal atividade. Caso contrário, ocorrerá um erro ao executar a atividade.
  4. Depois que os parâmetros forem definidos, confirme a atividade e salve seu fluxo de trabalho.

Monitoramento das variáveis de eventos

É possível monitorar as variáveis de eventos disponíveis no fluxo de trabalho, incluindo os parâmetros externos declarados. Para fazer isso, siga as etapas abaixo:
  1. Selecione a atividade que segue a External signal atividade e clique no Log and tasks botão.
  2. Na Tasks guia, clique no botão.
  3. O contexto de execução da tarefa é exibido (ID, status, duração etc.), incluindo todas as variáveis de eventos que agora estão disponíveis para uso no fluxo de trabalho.

Customizing a workflow with external parameters

Depois que o fluxo de trabalho é acionado, os parâmetros são ingeridos nas variáveis de eventos e podem ser usados para personalizar as atividades do fluxo de trabalho.
Eles podem, por exemplo, ser usados para definir qual público-alvo ler na Read audience atividade, o nome do arquivo a ser transferido na Transfer file atividade etc.
As atividades que podem ser personalizadas com variáveis de eventos são detalhadas nesta seção .

Uso de variáveis de eventos

As variáveis de eventos são usadas em uma expressão que deve respeitar a sintaxe Sintaxe padrão Padrão.
A sintaxe para usar variáveis de eventos deve seguir o formato abaixo e usar o nome do parâmetro que foi definido na External signal atividade (consulte Declaração dos parâmetros na atividade de sinal externo):
$(vars/@parameterName)

Nessa sintaxe, a função $ retorna o tipo de dados de string . Se desejar especificar outro tipo de dados, use as seguintes funções:
  • $long : número inteiro.
  • $float : número decimal.
  • $boolean : true/false.
  • $datetime : carimbo de data e hora.
Ao usar uma variável em uma atividade, a interface fornece ajuda para chamá-la.
  • : selecione a variável events entre todas as variáveis disponíveis no fluxo de trabalho (consulte ).
  • : editar expressões que combinam variáveis e funções. For more on the Expression editor, refer to this section .
Tópicos relacionados:

Personalização de atividades com variáveis de eventos

As variáveis de eventos podem ser usadas para personalizar várias atividades, listadas na seção abaixo. Para obter mais informações sobre como chamar uma variável de uma atividade, consulte esta seção .
Read audience atividade: defina o público-alvo a ser direcionado com base nas variáveis de eventos.
For more on how to use the activity, refer to the dedicated section .
Test atividade: crie condições com base nas variáveis de eventos.
For more on how to use the activity, refer to the dedicated section .
Transfer file atividade: personalize o arquivo a ser transferido com base nas variáveis de eventos.
For more on how to use the activity, refer to the dedicated section .
Query atividade: parâmetros podem ser referenciados em uma consulta usando expressões que combinam variáveis e funções de eventos. Para fazer isso, adicione uma regra e clique no Advanced mode link para acessar a janela de edição de expressão (consulte Edição de expressões avançadas).
For more on how to use the activity, refer to the dedicated section .
Channels atividades: personalize entregas com base nas variáveis de eventos.
Os valores dos parâmetros de entrega são recuperados sempre que a entrega é preparada.
A preparação recorrente das entregas é baseada no período de agregação da entrega. Por exemplo, se o período de agregação for "por dia", a entrega será repreparada apenas uma vez por dia. Se o valor de um parâmetro de entrega for modificado durante o dia, ele não será atualizado na entrega, pois já foi preparado uma vez.
Se você planeja chamar o fluxo de trabalho várias vezes por dia, use a No aggregation opção para que os parâmetros de entrega sejam atualizados sempre. Para obter mais informações sobre a configuração de entregas recorrentes, consulte esta seção .
Para personalizar uma entrega com base nas variáveis de eventos, você deve declarar primeiro na atividade de entrega as variáveis que deseja usar:
  1. Selecione a atividade e clique no botão para acessar as configurações.
  2. Selecione a General guia e adicione as variáveis de eventos que estarão disponíveis como campos de personalização na entrega.
  3. Clique no botão .Confirm
As variáveis de eventos declaradas agora estão disponíveis na lista de campos de personalização. Você pode usá-los na entrega para executar as ações abaixo:
  • Defina o nome do modelo a ser usado para a entrega.
    Esta ação está disponível somente para entregas recorrentes .
  • Personalize a entrega: ao selecionar um campo de personalização para configurar uma entrega, as variáveis de eventos estão disponíveis no Workflow parameters elemento. Você pode usá-los como qualquer campo de personalização, por exemplo, para definir o assunto da entrega, o remetente etc.
    A personalização da entrega é detalhada nesta seção .
Códigos do segmento: defina o código do segmento com base nas variáveis de eventos.
Essa ação pode ser executada a partir de qualquer atividade que permita definir um código de segmento como, por exemplo, Query ou Segmentation atividades.
Rótulo de entrega: defina o rótulo de entrega com base nas variáveis de eventos.

Caso de uso

O caso de uso abaixo mostra como chamar o fluxo de trabalho com parâmetros em seus fluxos de trabalho.
O objetivo é acionar um fluxo de trabalho a partir de uma chamada de API com parâmetros externos. Esse fluxo de trabalho carregará dados no banco de dados a partir de um arquivo e criará um público-alvo associado. Depois que o público-alvo for criado, um segundo fluxo de trabalho será acionado para enviar uma mensagem personalizada com os parâmetros externos definidos na chamada da API.
Para executar esse caso de uso, é necessário executar as ações abaixo:
  1. Faça uma chamada de API para acionar o Workflow 1 com parâmetros externos. Consulte a Etapa 1: Configuração da chamada da API.
  2. Criar fluxo de trabalho 1 : o fluxo de trabalho transferirá um arquivo e o carregará no banco de dados. Em seguida, ele testará se os dados estão vazios ou não e, eventualmente, salvará os perfis em um público-alvo. Finalmente, acionará o Workflow 2. Consulte a Etapa 2: Configuração do fluxo de trabalho 1 .
  3. Criar fluxo de trabalho 2 : o fluxo de trabalho lerá o público-alvo que foi criado no Fluxo de trabalho 1, em seguida, enviará uma mensagem personalizada para os perfis, com um código de segmento personalizado com os parâmetros. Consulte a Etapa 3: Configuração do fluxo de trabalho 2 .

Pré-requisitos

Antes de configurar os fluxos de trabalho, é necessário criar o Fluxo de trabalho 1 e 2 com uma External signal atividade em cada um deles. Dessa forma, você poderá direcionar essas atividades de sinal ao chamar os fluxos de trabalho.

Etapa 1: Configurar a chamada de API

Faça uma chamada de API para acionar o Workflow 1 com parâmetros. Para obter mais informações sobre a sintaxe de chamada da API, consulte a documentação das APIs REST do Campaign Standard.
Em nosso caso, queremos chamar o fluxo de trabalho com os parâmetros abaixo:
  • fileToTarget : o nome do arquivo que queremos importar para o banco de dados.
  • discountDesc : a descrição que queremos exibir na entrega do desconto.
-X POST https://mc.adobe.io/<ORGANIZATION>/campaign/<TRIGGER_URL>
-H 'Authorization: Bearer <ACCESS_TOKEN>' 
-H 'Cache-Control: no-cache' 
-H 'X-Api-Key: <API_KEY>' 
-H 'Content-Type: application/json;charset=utf-8' 
-H 'Content-Length:79' 
-i
-d {
-d "source:":"API",
-d "parameters":{
-d "fileToTarget":"profile.txt",
-d "discountDesc":"Running shoes"
-d } 

Etapa 2: Configuração do fluxo de trabalho 1

O fluxo de trabalho 1 será criado como abaixo:
  • External signal atividade: onde os parâmetros externos devem ser declarados para serem usados no fluxo de trabalho.
  • Transfer file atividade: importa o arquivo com o nome definido nos parâmetros.
  • Load file atividade: carrega dados do arquivo importado no banco de dados.
  • Update data atividade: insira ou atualize o banco de dados com dados do arquivo importado.
  • Test atividade: verifica se há dados importados.
  • Save audience atividade: se o arquivo contiver dados, salvará os perfis em um público-alvo.
  • End activity atividade: chama o Workflow 2 com os parâmetros que você deseja usar dentro dele.
Siga as etapas abaixo para configurar o fluxo de trabalho:
  1. Declarar os parâmetros que foram definidos na chamada da API. Para fazer isso, abra a External signal atividade e adicione os nomes e os tipos dos parâmetros.
  2. Adicione uma Transfer file atividade para importar dados para o banco de dados.Para fazer isso, arraste e solte a atividade, abra-a e selecione a Protocol guia.
  3. Selecione a Use a dynamic file path opção e use o parâmetro fileToTarget como o arquivo a ser transferido:
    $(vars/@fileToTarget)
    
    
  4. Carregue os dados do arquivo no banco de dados.
    Para fazer isso, arraste e solte uma Load file atividade no fluxo de trabalho e configure-a de acordo com suas necessidades.
  5. Insira e atualize o banco de dados com dados do arquivo importado.
    Para fazer isso, arraste e solte uma Update data atividade e, em seguida, selecione a guia Identification para adicionar um critério de reconciliação (no nosso caso, o campo de email ).
  6. Selecione a Fields to update guia e especifique os campos a serem atualizados no banco de dados (no nosso caso, os campos first name e email ).
  7. Verifique se os dados são recuperados do arquivo. Para fazer isso, arraste e solte uma Test atividade no fluxo de trabalho e clique no Add an element botão para adicionar uma condição.
  8. Nomeie e defina a condição. Em nosso caso, queremos testar se a transição de saída contém dados com a sintaxe abaixo:
    $long(vars/@recCount)>0
    
    
  9. Se os dados forem recuperados, salve-os em um público-alvo. Para fazer isso, adicione uma Save audience atividade ao Target e não uma transição vazia e abra-a.
  10. Selecione a Use a dynamic label opção e use o parâmetro fileToTarget como o rótulo do público-alvo:
    $(vars/@fileToTarget)
    
    
  11. Arraste e solte uma End atividade que chamará o Workflow 2 com parâmetros e abra-a.
  12. Selecione a External signal guia e especifique o fluxo de trabalho a ser acionado e a atividade do sinal associada.
  13. Defina os parâmetros que você deseja usar dentro do Workflow 2 e seus valores associados.
    Em nosso caso, queremos passar os parâmetros originalmente definidos na chamada da API ( fileToTarget e discountDesc ) e um parâmetro segmentCode adicional com um valor constante ("desconto de 20%").
O fluxo de trabalho 1 está configurado, agora é possível criar o Fluxo de trabalho 2. Para obter mais informações, consulte esta seção .

Etapa 3: Configuração do fluxo de trabalho 2

O fluxo de trabalho 2 será criado como abaixo:
  • External signal atividade: onde os parâmetros devem ser declarados para serem usados no fluxo de trabalho.
  • Read audience atividade: lê o público-alvo salvo no Fluxo de trabalho 1.
  • Email delivery atividade: envia uma mensagem recorrente para o público-alvo, personalizado com parâmetros.
Siga as etapas abaixo para configurar o fluxo de trabalho:
  1. Declarar os parâmetros que foram definidos no Workflow 1.
    Para fazer isso, abra a External signal atividade e adicione o nome e o tipo de cada parâmetro definido na End atividade do Workflow 1.
  2. Use o público-alvo salvo no Fluxo de trabalho 1. Para fazer isso, arraste e solte uma Read audience atividade no fluxo de trabalho e abra-a.
  3. Selecione a Use a dynamic audience opção e use o parâmetro fileToTarget como o nome do público-alvo para ler:
    $(vars/@fileToTarget)
    
    
  4. Nomeie a transição de saída de acordo com o parâmetro segmentCode .
    Para fazer isso, selecione a Transition guia e, em seguida, a Use a dynamic segment code opção.
  5. Use o parâmetro segmentCode como o nome da transição de saída:
    $(vars/@segmentCode)
    
    
  6. Arraste e solte uma Email delivery atividade para enviar uma mensagem ao público-alvo.
  7. Identifique os parâmetros a serem usados na mensagem para personalizá-la com o parâmetro discountDesc . Para fazer isso, abra as opções avançadas da atividade e adicione o nome e o valor do parâmetro.
  8. Agora você pode configurar a mensagem. Abra a atividade e selecione Recurring email .
  9. Selecione o modelo a ser usado e defina as propriedades do email de acordo com suas necessidades.
  10. Use o parâmetro discountDesc como um campo de personalização. Para fazer isso, selecione-o na lista de campos de personalização.
  11. Agora você pode concluir a configuração da mensagem e enviá-la como de costume.

Execução dos fluxos de trabalho

Depois que os fluxos de trabalho forem criados, você poderá executá-los. Verifique se os dois fluxos de trabalho foram iniciados antes de executar a chamada da API.