Obiekt wysyłający komunikat - kontekst

W przypadku obiektu wysyłającego wymagane mogą być informacje kontekstowe w celu zdefiniowania dodatkowych informacji wymaganych przez system, aby pomyślnie wysyłać komunikaty wychodzące. Należy otworzyć stronę Administrator > Integracja > Obiekt wysyłający komunikat i przejść do strony Kontekst.

Opis strony

Należy podać typ kontekstu i wartość kontekstową, zawierające parametry dla obiektów wysyłających, kiedy należy podać więcej informacji. Poniżej znajdują się informacje o obsługiwanych wartościach kontekstu dla różnych typów obiektów wysyłających.

Obiekt wysyłający wiadomości e-mail - kontekst

Obiekt wysyłający wiadomości e-mail używany jest przez usługę biznesową, która wysyła wiadomości e-mail w czasie rzeczywistym.

Obiekt wysyłający wiadomości e-mail musi wskazywać na klasę komunikatu RTHTTPSNDR. Ponadto dla obiektów wysyłających tego typu muszą być zdefiniowane następujące rekordy kontekstu.

Typ kontekstu Opis
Nazwa hosta SMTP Nazwa hosta serwera SMTP.
Nazwa użytkownika SMTP ID użytkownika używany przy dostępie do serwera SMTP.
Hasło SMTP Hasło używane przy dostępie do serwera SMTP.
Limit czasu oczekiwania na odpowiedź Czas, jaki system powinien przeznaczyć na oczekiwanie na odpowiedź w czasie rzeczywistym.

Obiekt wysyłający HTTP

Obiekt wysyłający HTTP wysyła komunikaty do serwera HTTP przy użyciu protokołu HTTP. Obiekty wysyłające HTTP powinny zawierać odwołanie do klasy komunikatów RTHTTPSNDR, RTJSONSNDR lub SOAPSNDR.

Do nawiązania sesji z docelowym serwerem HTTP potrzebne są różne parametry. Określa się je w kolekcji wartości kontekstowych dla obiektu wysyłającego. Z produktem dostarczany jest zestaw typów kontekstów związanych ze zmiennymi HTTP. W poniższej sekcji opisano typy kontekstów oraz, tam gdzie mają zastosowanie, wskazano poprawne wartości.

Przed zdefiniowaniem obiektu wysyłającego HTTP należy dowiedzieć się, jakiej formy żądań oczekuje serwer HTTP, a w szczególności uzyskać odpowiedzi na następujące pytania:

  • Jaki jest adres serwera HTTP?
  • Czy na serwerze HTTP używana jest metoda HTTP POST, czy GET?
  • Jak jest przekazywana zawartość komunikatu, jeśli serwer korzysta z metody POST? Czy używany jest element FORM protokołu HTTP, czy dane są przekazywane w treści komunikatu XML?
Typ kontekstu Opis Wartości
HTTP URL1 - URL9

Służą do konstruowania adresu URL docelowego serwera HTTP.

Ponieważ adres URL może być długi i skomplikowany, można rozbić go na mniejsze części, z których każda będzie zdefiniowana przez odrębny rekord kontekstu. Pełny adres URL jest budowany poprzez połączenie wartości od URL1 do URL9.

W poszczególnych segmentach adresu URL można używać zmiennych podstawianych. Jeśli w celu przekształcenia komunikatu w parametry metody GET protokołu HTTP zastosowana została transformacja XSL, ciąg znaków zastąpienia @XMLMSG@ może zostać użyty na potrzeby wywołań metody GET. Jest to przydatne w sytuacji, gdy formularz HTTP nie ma zastosowania do danego typu komunikatu.

Informacje na temat konfiguracji potrzebnej do obsługi dynamicznych adresów URL podczas wysyłania komunikatu wychodzącego znaleźć można w sekcji Obsługa dynamicznych adresów URL.

Metoda protokołu HTTP Metoda HTTP używana do wysyłania komunikatu.
Uwaga: Klasa komunikatów obiektu wysyłającego SOAP SOAPSNDR obsługuje tylko metodę POST.
POST lub GET
Metoda transportu HTTP Określa typ komunikatu. Można wysłać komunikat albo wysłać go i czekać na odpowiedź. Send lub sendReceive
Dane formularza HTTP

Kontekst używany, gdy komunikat ma format formularza HTML (Content-Type: application/x-www-form-urlencoded).

W kontekście tym określone są parametry (dane) formularza, które powinny być przekazane w komunikacie HTTP. Ponieważ formularz może mieć wiele parametrów, można dodać rekord kontekstu dla każdego parametru formularza.

Wartość parametru formularza ma postać x=y, gdzie x jest nazwą parametru formularza, a y jest jego wartością.

Jeśli y zawiera ciąg @XMLMSG@ (z zachowaniem wielkości liter), ciąg ten zostanie zastąpiony zawartością komunikatu XML będącym odpowiedzią usługi. Ciąg znaków @XMLMSG@ może być użyty w danych formularza protokołu HTTP lub w adresie URL protokołu HTTP, ale nie w obu tych parametrach.

Jeśli rekord kontekstu tego typu jest zdefiniowany dla obiektu wysyłającego, obiekt wysyłający wysyła komunikat w formacie formularze HTML, nawet jeśli ciąg @XMLMSG@ nie występuje w żadnym rekordzie kontekstu.

Jeśli rekord kontekstu tego typu nie jest zdefiniowany dla obiektu wysyłającego, komunikat XML jest wysyłany w formacie Content-Type: text/plain. W przypadku użycia metody POST jest umieszczany w treści komunikatu HTTP.

Rekord ten jest zawsze wymagany w przypadku użycia metody GET. Jeśli używana jest metoda GET i nie zostanie określony rekord kontekstu danych formularza, komunikaty nie będą przekazywane do serwera HTTP.

W wartościach danych formularza można używać zmiennych podstawianych.

Login użytkownika HTTP Serwer HTTP może wymagać uwierzytelniania. Należy wówczas dodać rekord kontekstu tego typu, aby określić login użytkownika.
Hasło logowania HTTP Serwer HTTP może wymagać uwierzytelniania. Należy wówczas dodać rekord kontekstu tego typu, aby określić hasło użytkownika.
Nagłówek HTTP

Niekiedy serwer HTTP wymaga, aby do komunikatów były dodawane nagłówki HTTP.

Dla każdego wymaganego nagłówka HTTP należy dodać rekord kontekstu z wartością w następującym formacie x:y, gdzie x jest nazwą nagłówka, a y jest wartością nagłówka.

Limit czasu oczekiwania protokołu HTTP Określa czas oczekiwania na nawiązanie połączenia z systemem zdalnym.
Kodowanie znaków Określa, czy komunikat powinien być zakodowany. Obiekt wysyłający doda do nagłówka typu zawartości HTTP ciąg ;charset=x, gdzie x jest wartością tego kontekstu, a przy wysyłaniu komunikat zostanie zakodowany w danym kodowaniu. UTF-8 lub UTF-16
Limit czasu oczekiwania na odpowiedź Czas, jaki system powinien przeznaczyć na oczekiwanie na wysłanie odpowiedzi przez system zdalny.
Typ zabezpieczeń obiektu wysyłającego Należy wskazać wymagany typ zabezpieczeń, który ma być stosowany (należy zwrócić uwagę, że dodatkowe typy zabezpieczeń mają zastosowanie tylko do obiektu wysyłającego SOAP. Więcej informacji można znaleźć poniżej). BASIC (podstawowe uwierzytelnianie HTTP), TEXT (czysty tekst tokenu nazwy użytkownika), DIGEST - uwierzytelnianie Digest tokenu nazwy użytkownika, OWSM - zabezpieczenia OAuth poprzez OWSM, OAUTH - zabezpieczenia OAuth.
Zbiór zasad OWSM

Ma zastosowanie tylko wtedy, gdy typ zabezpieczeń obiektu wysyłającego jest ustawiony na wartość OWSM. Umożliwia zdefiniowanie zbioru zasad, który ma być stosowany.

Należy wprowadzić poprawną wartość dla rozszerzanej listy wartości Zbiór zasad (F1-SetOfPolicies). W produkcie dostępna jest wartość F1-OAUTH, która może być tutaj użyta.
Typ przyznania OAuth

Ma zastosowanie tylko wtedy, gdy typ zabezpieczeń obiektu wysyłającego jest ustawiony na wartość OAUTH . Służy do definiowania metody specyfikacji OAuth na potrzeby uzyskiwania tokenu dostępu.

client_​credentials
Adres URL tokenu dostępu OAuth

Służy do tworzenia adresu URL docelowego serwera autoryzacji. Do utworzenia adresu URL można użyć zmiennych zastępowania.

ID klienta OAuth

Wygenerowany identyfikator bieżącej aplikacji na serwerze autoryzacji systemu zewnętrznego.

Tajny klucz klienta OAuth

Tajny klucz sparowany z ID klienta OAuth podanym przez serwer autoryzacji systemu zewnętrznego.

Zestaw kluczy OAuth

Definiuje zestaw kluczy używany do przechowywania ID klienta OAuth i tajnego klucza dostarczanego przez serwer autoryzacji systemu zewnętrznego. Jeśli zostanie określony zestaw kluczy, zapisy kontekstu "ID klienta OAuth" i "Tajny klucz klienta OAuth" nie będą dozwolone.

Zakres interfejsu API OAuth REST

Poziom autoryzacji przyznany przez punkt końcowy.

Szczegóły żądania tokenu OAuth w treści

Domyślnie żądanie tokenu autoryzacji zawiera w nagłówku komunikatu informacje o ID klienta i tajnym kluczu. Ten typ kontekstu może być używany do wskazania, że informacje te powinny być wysyłane w treści żądania.

Należy ustawić w tej opcji wartość "Y", aby wysłać informacje o ID klienta i tajnym kluczu w treści żądania tokenu autoryzacji.

Obiekt HTTP wysyłający w czasie rzeczywistym

Poniższy typ kontekstu ma zastosowanie tylko w przypadku obiektów wysyłających z klasą komunikatu RTHTTPSNDR.

Typ kontekstu Opis
Typ zawartości Należy podać tutaj wartość, aby nadpisać wartość atrybutu Typ zawartości w nagłówku HTTP. Wartość domyślna tego atrybutu to text/xml.

Obiekt wysyłający SOAP

Obiekt wysyłający SOAP to obiekt wysyłający HTTP, który automatycznie dodaje obsługę formatu SOAP. Oprócz wartości kontekstu wymienionych powyżej, dla tego typu obiektu wysyłającego (klasa komunikatu SOAPSNDR) można określić następujące zapisy kontekstu.

Typ kontekstu Opis Wartości
Identyfikator URI przestrzeni nazw komunikatu Służy do określania konkretnej przestrzeni nazw, która ma być uwzględniania w komunikatach związanych z tym obiektem wysyłającym. Wartość ta jest używana tylko wtedy, gdy połączenie komunikatu zewnętrznego z tym obiektem wysyłającym jest skonfigurowane z Opcją przestrzeni nazw, dla której ustawiono wartość Skonfigurowane w obiekcie wysyłającym.
Datownik wstawiania SOAP Umożliwia określenie, czy datownik ma zostać dodany. Domyślną wartością jest "N". Y lub N
Opóźnienie wygaśnięcia SOAP (w sekundach) Służy do określenia opóźnienia wygaśnięcia, aby dodać datownik. Wartość domyślna to 60.
Typ zabezpieczeń obiektu wysyłającego Dodatkowe typy zabezpieczeń są obsługiwane przez obiekty wysyłające SOAP na potrzeby konkretnych integracji osoby trzeciej. CIM - korzysta z odpowiedniej przestrzeni nazw i dodaje informacje o zabezpieczeniach w nagłówku SOAP specyficznym dla Landis+Gyr, MS_​V30 - korzysta z odpowiedniej przestrzeni nazw i dodaje informacje o zabezpieczeniach w nagłówku SOAP specyficznym dla MultiSpeak v3.0, MS_​V41R - korzysta z odpowiedniej przestrzeni nazw i dodaje informacje o zabezpieczeniach w nagłówku SOAP specyficznym dla MultiSpeak v4.1. ITRON - korzysta z odpowiednich informacji o zabezpieczeniach nagłówka SOAP w nagłówku SOAP specyficznym dla ITRON.
Uwaga: Informacje o dynamicznym dołączaniu parametrów nagłówka SOAP podczas wysyłania komunikatu znaleźć można w sekcji Dodawanie parametrów nagłówka SOAP w czasie wykonywania.

Obiekt wysyłający JMS

To obiekt wysyłający JMS wysyła komunikaty do kolejki lub tematu JMS. Obiekty wysyłające JMS powinny zawierać odwołanie do klasy komunikatów, odpowiednio: RTJMSQSNDR lub RTJMSTSNDR.

Poniższe parametry używane są do nawiązania połączenia z zasobem JMS.

Typ kontekstu Opis Wartości
Typ komunikatu JMS (bajty(Y)/tekst(N) Wskazuje, czy dane są wysyłane jako wiadomość binarna, czy tekstowa. Y lub N
Nazwa użytkownika JMS Należy wprowadzić nazwę użytkownika do nawiązania połączenia z zasobem JMS.
Hasło użytkownika JMS Należy wprowadzić hasło użytkownika do nawiązania połączenia z zasobem JMS.
Nagłówek JMS

Jeśli w przypadku danego komunikatu wymagane są wartości nagłówka JMS, należy użyć tego typu kontekstu.

Dla każdego wymaganego nagłówka JMS należy dodać rekord kontekstu zawierający wartość w następującym formacie: x:y, gdzie x jest nazwą nagłówka, a y jest jego wartością.