Integração da interface Criar correspondência com o portal personalizado

Visão geral

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

Invocação baseada em URL

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 para o modelo de letra (usando o parâmetro cmLetterId) ou o nome do modelo Carta (usando o parâmetro cmLetterName)

  • 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.
Se o portal tiver o nome do modelo Carta em mãos, o URL poderá ser
https://[server]:[port]/content/cm/createcorrespondence.html?cmLetterName=[letter name]&cmDataUrl=[data URL].

OBSERVAÇÃO

Chamar dessa forma não é seguro, pois os parâmetros necessários são passados como uma solicitação do GET, expondo o mesmo (claramente visível) no URL.

OBSERVAÇÃO

Antes de chamar o aplicativo Criar correspondência , salve e faça upload dos dados para chamar a interface do usuário Criar correspondência no dataURL fornecido. Isso pode ser feito pelo próprio portal personalizado ou por outro processo back-end.

Invocação baseada em dados em linha

Outra (e uma maneira mais segura) de chamar o aplicativo Criar correspondência pode ser simplesmente pressionar o URL em https://[server]:[port]/[contextPath]/aem/forms/createcorrespondence.html, enquanto envia 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 Create Correspondence em linha (como parte da mesma solicitação, usando o parâmetro cmData ), que não era possível/ideal na abordagem anterior.

Parâmetros para especificar a letra

Nome Tipo Descrição
cmLetterInstanceId Sequência de caracteres O identificador da instância da carta.
cmLetterName Sequência de caracteres

O identificador do modelo de carta.

Se houver várias letras CM com o mesmo nome em um servidor, o uso do parâmetro cmLetterName no URL acionará um erro "Existem várias letras com o nome". Nesse caso, use o parâmetro cmLetterId no URL em vez de cmLetterName.
cmLetterId Sequência de caracteres O nome do modelo Carta.

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

Parâmetros para especificar a fonte de dados XML

Nome Tipo Descrição
cmDataUrl
 URL Dados XML de um arquivo de origem usando protocolos básicos como cq, ftp, http ou arquivo.
cmLetterInstanceId Sequência de caracteres Uso de dados xml disponíveis em Instância de Carta.
cmUseTestData Booleano Para reutilizar os dados de teste anexados no 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

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 os problemas de cache do navegador.

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

Nesta página