DocumentaçãoAEM 6.5Guia do usuário

Integrando Criar interface do usuário de correspondência ao portal personalizado integrating-create-correspondence-ui-with-your-custom-portal

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Administrador
  • Usuário
  • Desenvolvedor

Visão geral overview

Este artigo detalha como é possível integrar a opção Criar solução de correspondência ao seu ambiente.

Chamada baseada em URL url-based-invocation

Uma maneira de chamar o aplicativo Criar correspondência de um portal personalizado é preparar o URL com os seguintes parâmetros de solicitação:

  • o identificador do modelo de correspondência (usando o parâmetro cmLetterId).

  • o URL para os dados XML obtidos da fonte de dados desejada (usando o parâmetro cmDataUrl ).

Por exemplo, o portal personalizado prepararia o URL como
https://'[server]:[port]'/[contextPath]/aem/forms/createcorrespondence.html?random=[timestamp]&cmLetterId=[letter identifier]&cmDataUrl=[data URL], que pode ser o href de um link no portal.

NOTE
Chamar dessa maneira não é seguro, pois os parâmetros necessários são transmitidos como uma solicitação do GET, expondo o mesmo (claramente visível) no URL.
NOTE
Antes de chamar o aplicativo Criar correspondência, salve e faça upload dos dados para chamar a interface Criar correspondência no URL de dados fornecido. Isso pode ser feito no próprio portal personalizado ou por meio de outro processo de back-end.

Chamada embutida baseada em dados inline-data-based-invocation

Outra maneira (e mais segura) de chamar o aplicativo Criar Correspondência poderia ser simplesmente acessar a URL em https://'[server]:[port]'/[contextPath]/aem/forms/createcorrespondence.html, enquanto enviava os parâmetros e dados para chamar o aplicativo Criar Correspondência como uma solicitação POST (ocultando-os do usuário final). Isso também significa que agora é possível transmitir os dados XML para o aplicativo Criar correspondência em linha (como parte da mesma solicitação, usando o parâmetro cmData ), o que não era possível/ideal na abordagem anterior.

Parâmetros para especificação de carta parameters-for-specifying-letter

Nome
Tipo
Descrição
cmLetterInstanceId
String
O identificador para a ocorrência de carta.
cmLetterId
String
O nome do modelo de Carta.

A ordem dos parâmetros na tabela especifica a preferência dos parâmetros usados para carregar a correspondência.

Parâmetros para especificação da fonte de dados XML parameters-for-specifying-the-xml-data-source

Nome
Tipo
Descrição
cmDataUrl
URL
Dados XML de um arquivo de origem usando protocolos básicos como cq, ftp, http ou file.
cmLetterInstanceId
String
Uso de dados xml disponíveis na Instância de Carta.
cmUseTestData
Booleano
Para reutilizar os dados de teste anexados ao dicionário de dados.

A ordem dos parâmetros na tabela especifica a preferência dos parâmetros usados para carregar os dados XML.

Outros parâmetros other-parameters

Nome
Tipo
Descrição
cmPreview
Booleano
Verdadeiro para abrir a carta no modo de visualização
Aleatório
Carimbo de data e hora
Para resolver problemas de cache do navegador.

Se você estiver usando o protocolo http ou cq para cmDataURL, o URL de http/cq deverá estar acessível anonimamente.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2