Configuração de ações externas

As ações externas permitem que as jornadas de conta no Journey Optimizer B2B edition se conectem a sistemas externos diretamente da tela de jornada. Quando um público-alvo de conta atinge um nó de ação externa, o sistema faz uma chamada de saída assíncrona para um serviço externo configurado, transmitindo dados de atributos de público-alvo para contas, pessoas ou ambos. O serviço externo processa os dados e responde usando um retorno de chamada, retornando os dados e os metadados do público-alvo que podem ser usados para orientar a execução da jornada.

Esse recurso oferece suporte a dois tipos de nó do jornada:

  • Ação externa - Chama um serviço externo e continua ao longo de um único caminho de saída. Ideal para disparar e esquecer integrações, como a atualização de um registro CRM ou o acionamento de uma notificação downstream.
  • Caminhos divididos externos - Chama um serviço externo e avalia a resposta para rotear contas ao longo de um dos vários caminhos definidos.
NOTE
Os serviços de ação externa são compatíveis somente com jornadas de conta. Esses tipos de nó não estão disponíveis para jornadas de pessoas.

Visão geral da implementação

A criação de ações externas exige coordenação entre três funções em sequência:

Implementar o serviço externo implement-service

O desenvolvedor deve criar e publicar um serviço Web voltado para o público que esteja em conformidade com a Interface do Provedor de Serviços de Ações Externas do Adobe Journey Optimizer B2B edition.

NOTE
A função de retorno de chamada requer um token de portador. Recupere configurando as credenciais de Servidor para Servidor do OAuth na Adobe Developer Console para sua Organização IMS.

Depois que o serviço estiver ativo, forneça o URL para a especificação OpenAPI e as credenciais de autenticação ao administrador do produto responsável pela configuração da ação.

Configurar a ação configure-action

Uma ação deve ser configurada e ativada antes que os profissionais de marketing possam usá-la em uma jornada. As ações são criadas no estado Rascunho e suas alterações são salvas automaticamente. Permanece como rascunho até que você o ative.

PREREQUISITES
Obtenha o URL para a especificação OpenAPI e as credenciais de autenticação do desenvolvedor antes de adicionar a configuração.
Para definir e ativar uma ação externa, você deve ter a Gerenciar configurações de administrador B2B permissão de produto.
  1. Vá para Administração > Configurações.

  2. Clique em Ações Externas no painel intermediário.

    Acessar o espaço de configuração de Ações Externas {width="800" modal="regular"}

  3. Clique em Criar ação na parte superior direita.

  4. Insira a URL para a especificação OpenAPI do seu serviço externo e clique em Criar.

    Insira a URL do serviço {width="500"}

    O serviço externo deve estar ativo e acessível para que esta etapa seja bem-sucedida. Se houver um erro de validação, a caixa de diálogo exibirá uma mensagem para descrever o erro e uma sugestão para resolvê-lo. Para obter mais informações, consulte Solução de problemas.

  5. Quando a URL for resolvida com êxito, revise os Detalhes do serviço.

    Os detalhes do serviço são lidos diretamente da especificação OpenAPI quando a ação é criada. Não é possível alterar essas propriedades na configuração após a criação.

    table 0-row-3 1-row-3 2-row-3 3-row-3
    Propriedade Descrição Propriedade de especificação OpenAPI
    Nome Nome da ação info.title
    Descrição Descrição da ação info.description
    URL URL da especificação OpenAPI que define o serviço externo servers.url
  6. Insira as credenciais de Autenticação para o serviço externo (components.securitySchemes).

    note
    NOTE
    Os campos de credencial exibidos dependem do mecanismo de autenticação definido no serviço externo. Os tipos compatíveis são Chave de API, OAuth2 e Autenticação básica de HTTP.

    Adicionar as credenciais de autenticação {width="600" modal="regular"}

    Você pode alterar as credenciais conforme necessário quando a ação configurada estiver no status Rascunho ou Ativo.

  7. Clique em Next.

  8. Defina as propriedades Configurações para definir como a ação troca dados com o serviço externo.

    note
    NOTE
    As propriedades marcadas como Estáticas não são atualizáveis no momento da configuração e se baseiam na definição do serviço.
    • Tipo de ação (Estática) - O tipo de nó de jornada com suporte:

      • Ação externa (enableSplitPath = falso)
      • Caminho dividido da ação externa (enableSplitPath = verdadeiro)

      Não é possível alterar o tipo de ação após criar a configuração da ação.

    • Acessadores (Estático) - (Somente caminho dividido de ação externa) As variáveis retornadas pelo serviço externo para estarem disponíveis como condições de caminho em um nó de caminho dividido externo. (invocationPayloadDef.accessorsMetadata)

    • Contexto de Jornada (Estático) - O escopo dos dados de público enviados na solicitação (supportedEntityType):

      • Conta - Envia somente contas

      • Pessoas - Envia somente pessoas

      • Pessoas na Conta - Envia contas e pessoas relacionadas à conta

    • Campos de Saída - Mapeie cada campo da tabela para um campo XDM. Esses campos são enviados no corpo da solicitação para o serviço externo. Propriedades de definição de serviço: invocationPayloadDef.accountFields, invocationPayloadDef.fields.

      Mapear campos de saída de ação externa {width="600" modal="regular"}

    • Campos de Entrada - Mapeie cada campo da tabela para um campo XDM atualizável. Esses campos são preenchidos a partir da resposta do serviço externo. Propriedades de definição de serviço: callbackPayloadDef.accountFields, callbackPayloadDef.fields. Atualizável após a criação.

    • Parâmetros de cabeçalho - Insira um valor para cada linha a ser transmitida como um cabeçalho HTTP na solicitação. Propriedade de definição de serviço: invocationPayloadDef.headers.

    • Tempo limite - Insira o número de minutos para aguardar o serviço externo invocar o retorno de chamada antes que a solicitação seja considerada com falha. Propriedade de definição de serviço: timeout.

    • Atributos globais - Insira um valor para cada linha a ser incluída como um campo estático no corpo da solicitação. Propriedade de definição de serviço: invocationPayloadDef.globalAttributes.

      Parâmetros de cabeçalho de ação externa, tempo limite e atributos globais {width="600" modal="regular"}

  9. Clique na Seta para trás para retornar à lista e manter a ação no estado Rascunho.

    Ou clique em Ativar para alterar a configuração da ação para o estado Ativo. A ação externa configurada deve estar ativa para torná-la disponível para uso nas jornadas da conta.

Solução de problemas troubleshooting

Quando você insere a URL para a especificação OpenAPI do seu serviço externo e clica em Criar, o sistema executa a validação do serviço. Ao encontrar um erro, a caixa de diálogo exibe uma mensagem para descrevê-lo.

Mensagem de erro de validação do serviço de URL da ação externa {width="600" modal="regular"}

NOTE
Muitos dos erros a seguir exigem que você trabalhe com o desenvolvedor que criou e publicou o serviço Web voltado para o público para resolver.

Detalhes do erro de validação

Erro exibido
Por que aconteceu
O que fazer
This URL is already used by another external action
Este URL de especificação já está registrado para uma ação diferente em sua organização.
Use um URL de especificação diferente ou exclua a ação existente que já o utiliza.
An action with this name already exists
O info.title na sua especificação corresponde a uma ação que já existe
Altere o título do campo info.title da sua especificação para algo exclusivo.
Duplicate operation ID found in the specification
Duas ou mais operações em sua especificação compartilham o mesmo operationId.
Atribua a cada operação um operationId exclusivo.
Field in the specification exceeds the maximum allowed length
Um campo de texto na sua especificação (como um título ou descrição) é muito longo.
Encurte o campo sinalizado.
The entity type value is invalid
Uma extensão x- específica do Adobe para o tipo de entidade tem um valor não reconhecido
Corrija o tipo de entidade para um valor compatível. Consulte a documentação do desenvolvedor para conhecer as opções válidas.
The provided document is not a valid OpenAPI specification
A especificação não pode ser analisada estruturalmente.
Valide sua especificação em relação ao esquema OpenAPI 3.0 e corrija quaisquer problemas.
Required OpenAPI field is missing
Um campo obrigatório padrão OpenAPI está ausente (como info ou paths).
Adicione o campo ausente.
Required endpoint is missing from the specification
Um endpoint exigido pelo Adobe Journey Optimizer B2B edition não está definido em sua especificação.
Adicione o endpoint necessário. Consulte a documentação do desenvolvedor para saber quais pontos de extremidade são necessários.
Required extension field is missing
Um campo de extensão obrigatório do Adobe x- está ausente da sua especificação.
Adicione o campo de extensão ausente conforme descrito na documentação.
Security schemes are missing from the specification
Sua especificação não tem securitySchemes definido em components.
Defina pelo menos um esquema de segurança.
Multiple authentication types are not supported
Sua especificação define mais de um esquema de autenticação.
Atualize sua especificação para usar um único tipo de autenticação.
The authentication type is not supported
O tipo de esquema de segurança que você usou (como oauth2 ou openIdConnect) não é suportado.
Alternar para um tipo de autenticação compatível. Consulte a documentação do desenvolvedor para conhecer as opções compatíveis.
The OpenAPI version is not supported
Incompatibilidade de versão no nível de especificação
Atualize sua especificação para usar o OpenAPI 3.0.x.
An unexpected error occurred
Um problema não classificado foi encontrado na sua especificação.
Verifique se há algo incomum em sua especificação e tente novamente. Se o erro persistir, entre em contato com o suporte.

Adicionar um nó externo a uma jornada add-journey-node

Após a ativação de uma ação, os profissionais de marketing podem adicionar um nó Ação externa ou Caminho dividido externo a qualquer jornada de conta. Para obter informações sobre como adicionar e usar esses nós na tela de jornada da conta, consulte Nós externos.

recommendation-more-help
journey-optimizer-b2b-help-user