Remetente da Mensagem - Contexto
O remetente pode exigir informações de contexto para definir as informações adicionais de que o sistema precisa para enviar as mensagens de saída com êxito. Abra
e navegue até a página Contexto.Descrição da Página
Defina o Tipo de Contexto e o Valor de Contexto, que contêm parâmetros para remetentes quando mais informações forem necessárias. Consulte abaixo os valores de contexto suportados para os diferentes tipos de remetentes.
Contexto do Remetente de E-mail
O remetente do e-mail é usado pelo serviço de negócios que envia mensagens de e-mail em tempo real.
Um remetente de e-mail deve apontar para a Classe de Mensagem RTHTTPSNDR. Além disso, os seguintes registros de contexto devem ser definidos para remetentes desse tipo.
Tipo de Contexto | Descrição |
---|---|
Nome do Host SMTP | O nome do host do servidor SMTP. |
Nome do Usuário do SMTP | O ID de usuário utilizado para acessar o servidor SMTP. |
Senha do SMTP | A senha utilizada para acessar o servidor SMTP. |
Expiração de Resposta | A quantidade de tempo que o sistema deve aguardar uma resposta em tempo real. |
Remetente HTTP
O remetente HTTP é o que envia mensagens a um servidor HTTP usando o protocolo HTTP. Os remetentes HTTP devem fazer referência a uma Classe de Mensagem RTHTTPSNDR, RTJSONSNDR ou SOAPSNDR.
Vários parâmetros são obrigatórios para estabelecer uma sessão com o servidor HTTP de destino. Especifique esses parâmetros definindo um conjunto de valores de contexto para o remetente. Um conjunto de tipos de contexto relacionados a variáveis HTTP é fornecido com o produto. A seção seguinte descreve os tipos de contexto e indica os valores válidos conforme apropriado.
Antes de definir o remetente HTTP, é preciso verificar como o servidor HTTP do outro lado espera receber a solicitação e, particularmente, responder às seguintes perguntas:
- Qual é o endereço do servidor HTTP?
- O servidor HTTP está usando um método POST ou GET HTTP?
- Se o servidor estiver usando POST, como os conteúdos das mensagens são especificados? Ele usa um HTTP FORM ou especifica os dados no corpo de uma mensagem XML?
Tipo de Contexto | Descrição | Valores |
---|---|---|
URL1 - URL9 HTTP |
Usado para gerar o URL do servidor HTTP de destino. Como o URL pode ser longo e complexo, é possível dividi-lo em partes menores, cada uma definida por um registro de contexto separado. O URL completo é gerado pela concatenação dos valores em URL1 a URL9. É possível usar variáveis de substituição na introdução de valores para partes de URL. Note que a string de substituição @XMLMSG@ pode ser usada nas chamadas GET caso um XSL tenha sido aplicado para converter a mensagem em parâmetros de GET HTTP. Isso é útil caso o Formulário HTTP não se aplique ao tipo de mensagem. Consulte Suporte a URLs Dinâmicos para ver as configurações necessárias para dar suporte a URLs dinâmicos ao enviar uma mensagem de saída. |
|
Método HTTP | O método HTTP usado para enviar a mensagem. Observação: A classe de mensagem de remetente SOAP SOAPSNDR suporta somente o método POST.
|
POST ou GET |
Método de Transporte HTTP | Especifica o tipo de mensagem. Você pode enviar a mensagem ou enviar e aguardar uma resposta. | Send ou sendReceive |
Dados do Formulário HTTP |
Usado quando a mensagem está no formato de um Form HTML ( Esse contexto especifica os parâmetros do form (dados) que devem ser especificados na mensagem HTTP. Como um form pode ter vários parâmetros, será preciso adicionar um registro de contexto para cada parâmetro de form. O valor de um parâmetro de form assume o formato de x=y, em que x é o nome do parâmetro de form e y é o seu valor. Se y contiver a string @XMLMSG@ (com diferenciação entre maiúsculas e minúsculas), essa string será substituída pelo conteúdo da mensagem XML de resposta do serviço. A string @XMLMSG@ pode ser usada nos Dados do Formulário HTTP ou no URL HTTP, mas não em ambos. Se um registro de contexto desse tipo for definido para um remetente, este usará o formato de mensagem HTML Form para enviar a mensagem, mesmo se @XMLMSG@ não for especificada em um dos registros de contexto. Se um registro de contexto desse tipo não for definido para um remetente, o XML será enviado com Sempre obrigatório na utilização do método GET. Se você estiver usando o método GET e não especificar um registro de contexto Form Data, nenhuma mensagem será transferida ao servidor HTTP. É possível usar variáveis de substituição na introdução de valores para Form Data. |
|
Usuário de Log-in HTTP | O servidor HTTP pode necessitar de autenticação. Adicione um registro de contexto desse tipo para especificar o usuário de log-in a ser utilizado. | |
Senha de Log-in HTTP | O servidor HTTP pode necessitar de autenticação. Adicione um registro de contexto desse tipo para especificar a senha de log-in a ser utilizada. | |
Cabeçalho HTTP |
Às vezes, o servidor HTTP do outro lado pode solicitar a adição de cabeçalhos HTTP à mensagem. Para cada cabeçalho HTTP que precisa ser especificado, você deve adicionar um registro de contexto com um valor tendo o seguinte formato x:y , em que x é o nome de cabeçalho e y o valor do cabeçalho |
|
Expiração HTTP | Indica a quantidade de tempo de espera para que uma conexão com o sistema remoto seja estabelecida. | |
Codificação de Caracteres | Indica se a mensagem deve ser codificada. O remetente adicionará ao cabeçalho de tipo de conteúdo de HTTP a string ;charset=x , em que x é o valor desse contexto e, ao enviar a mensagem, ele codificará os dados nessa codificação. |
UTF-8 ou UTF-16 |
Expiração de Resposta | A quantidade de tempo que o sistema deve aguardar para que o sistema remoto envie uma resposta. | |
Tipo de Segurança do Remetente | Indica o tipo de segurança desejado a ser aplicado. (Observe que os tipos de segurança adicionais são aplicáveis somente ao Remetente SOAP. Mais detalhes abaixo.) | BASIC (HTTP Básico), TEXT (texto simples de Token do Nome do Usuário), DIGEST – Digest de Token do Nome do Usuário, OWSM – OAuth Security via OWSM, OAUTH - Segurança OAuth. |
Conjunto de Políticas OWSM |
Aplicável apenas se o Tipo de Segurança do Remetente for OWSM. Define o conjunto de política a ser aplicado. |
Insira um valor válido para a consulta extensível Conjunto de Políticas (F1-SetOfPolicies). O produto fornece o valor F1-OAUTH, que pode ser usado aqui. |
Tipo de Concessão de OAuth |
Aplicável apenas se o Tipo de Segurança do Remetente forOAUTH . Define o método de especificação OAuth para adquirir um token de acesso. |
client_credentials |
URL do Token de Acesso do OAuth |
Usado para gerar o URL do servidor de autorização de destino. É possível usar variáveis de substituição para construir o URL. |
|
ID do Cliente OAuth |
O identificador gerado para o aplicativo atual no servidor de autorização do sistema externo. |
|
Segredo do Cliente OAuth |
O segredo emparelhado com o ID do Cliente OAuth conforme fornecido pelo servidor de autorização do sistema externo. |
|
Keyrings do OAuth |
Define o keyring usado para armazenar o ID do Cliente OAuth e o segredo fornecido pelo servidor de autorização do sistema externo. Se um keyring for especificado, as entradas de contexto OAuth ID do Cliente e OAuth Segredo do Cliente não serão permitidas. |
|
Escopo da API REST do OAuth |
O nível de autorização concedido pelo ponto final. |
|
Detalhes da Solicitação de Token OAuth no Corpo |
Por padrão, a solicitação de token de autorização inclui as informações de ID do Cliente e de Segredo no cabeçalho da mensagem. Esse tipo de contexto pode ser usado para indicar que essas informações devem ser enviadas no corpo da solicitação. |
Defina como "S" para enviar as informações de ID do Cliente e de Segredo como parte do corpo da solicitação de token de autorização. |
Remetente HTTP em Tempo real
O tipo de contexto a seguir se aplica somente a remetentes com a classe de mensagem RTHTTPSNDR.
Tipo de Contexto | Descrição |
---|---|
Tipo de Conteúdo | Preencha um valor aqui para substituir o atributo Content-Type no cabeçalho HTTP que, por padrão, é text/xml. |
Remetente SOAP
Um remetente SOAP é um remetente HTTP que adiciona automaticamente suporte ao formato SOAP. Para esse tipo de remetente (classe de mensagem SOAPSNDR), além dos valores de contexto listados acima, as seguintes entradas de contexto podem ser fornecidas.
Tipo de Contexto | Descrição | Valores |
---|---|---|
URI de Namespace da Mensagem | Usado para indicar um namespace específico a ser incluído nas mensagens desse remetente. Esse valor é usado apenas quando o link Mensagem Externa para esse remetente é configurado com uma Opção de Namespace de Configurado no Remetente. | |
Inserir Data/Hora do SOAP | Indica se a data/hora deve ser adicionada. O valor padrão é 'N'. | S ou N |
Atraso da Expiração do SOAP (em segundos) | Indica um atraso de expiração a ser adicionado à data/hora. O valor padrão é 60. | |
Tipo de Segurança do Remetente | Tipos de segurança adicionais são suportados para remetentes SOAP para integrações de terceiros específicas. | CIM - Usa um namespace apropriado e adiciona informações de segurança no cabeçalho SOAP específico a Landis+Gyr, MS_V30 - Usa um namespace apropriado e adiciona informações de segurança no cabeçalho SOAP específico a MultiSpeak v3.0, MS_V41R - Usa um namespace apropriado e adiciona informações de segurança no cabeçalho SOAP específico a MultiSpeak v4.1. ITRON - Usa informações de segurança de cabeçalho SOAP apropriadas no cabeçalho SOAP específico ao Itron. |
Remetente JMS
Um remetente JMS envia mensagens a uma fila ou tópico JMS. Os remetentes JMS devem fazer referência a uma Classe de Mensagem RTJMSQSNDR ou RTJMSTSNDR, respectivamente.
Os parâmetros a seguir são usados para estabelecer conexão com o recurso JMS.
Tipo de Contexto | Descrição | Valores |
---|---|---|
Tipo de Mensagem JMS (Bytes(S)/Texto(N) | Indica se os dados são enviados como uma mensagem de bytes ou de texto. | S ou N |
Nome do Usuário JMS | Insira o nome do usuário para se conectar ao recurso JMS. | |
Senha do Usuário JMS | Insira a senha usada para se conectar ao recurso JMS. | |
Cabeçalho JMS |
Se os valores do cabeçalho JMS forem necessários para a mensagem, use este tipo de contexto. Para cada cabeçalho JMS que precisa ser especificado, adicione um registro de contexto com um valor no formato x:y, em que x é o nome do cabeçalho e y é o valor. |
Variáveis do Aplicativo
Os parâmetros a seguir podem ser usados para capturar variáveis de aplicativo.
Tipo de Contexto | Descrição | Valores |
---|---|---|
ID do Aplicativo | Identifica o ambiente atual desta API. | Determinado no momento do provisionamento pelo provedor de API. |
ID do Locatário | Identifica o locatário atual para esta API. | Determinado no momento do provisionamento pelo provedor de API. |