Page History

Parametr pozwala na dodanie dodatkowych nagłówków do żądania. Parametr można wykorzystać np. do wymuszenia odpowiedzi z API w formacie JSON. W takim wypadku należy dodać wiersz w opisywanym parametrze i w polu "Nagłówek" podać wartość "Accept", natomiast w polu "Wartość" podać "application/json".

Image Removed
Poprawnie skonfigurowane API na żądanie z powyższym nagłówkiem powinno zwrócić dane w formacie JSON lub odpowiedzieć błędem w przypadku, gdy na to żądanie nie można odpowiedzieć w formacie JSON.Ścieżka (podobna do XPath) służąca do wyodrębnienia danych z wynikowego JSON-a. Dokumentacja korzystania z JsonPath - https://github.com/json-path/JsonPath

Image Removed

Polish

Info
Instrukcja tworzenia źródeł danych w systemie - http://192.168.1.52:8081/confluence/pages/viewpage.action?pageId=13272439

Wtyczka zawiera implementację źródeł danych operujących na RESTful API.

Za pomocą opisywanych źródeł danych można odczytywać i przekazywać dane pomiędzy systemem PlusWorkflow a zewnętrznym API z wykorzystaniem metod protokołu HTTP (GET, POST itd.).

Info
Istnieje również możliwość komunikacji z wewnętrznym API systemu. W takim przypadku w adresie URL należy użyć domeny "localhost"

Opis konfiguracji:

Nazwa parametru

Opis parametru

Wymagalność

Autoryzacja

Schemat autoryzacji żądania. Jeśli żądany endpoint nie wymaga autoryzacji pole należy zostawić puste. Opis definiowania szablonów autoryzacji znajduje się TUTAJ.

Opcjonalny

Dodatkowe nagłówki

Opcjonalny

Metoda HTTP

Lista metod protokołu HTTP. Dostępne metody: GET, HEAD, POST, PUT, DELETE, PATCH. Należy wybrać wymaganą metodę żądania zgodnie z dokumentacją API.

Wymagany

URL

Adres URL endpointu, do którego wysłane zostanie żądanie. W przypadku wywołania akcję z API tego samego systemu PlusWorkflow, w którym skonfigurowane jest źródło adres URL musi zawierać domenę "localhost".

Wymagany

Content-Type

Parametr pozwala na zdefiniowanie formatu danych przekazywanych w ciele żądania. Parametr jest stosowany tylko, gdy wśród parametrów wejściowych znajdują się parametry typu "Parametr Body". W pozostałych przypadkach wartość tego parametru nie ma znaczenia.

Wymagany

Parametry wejściowe

Id parametrów wejściowych

Nazwy parametrów wejściowych

Typy parametrów wejściowych

Określa id parametrów wejściowych.

W przypadku parametru typu "Paramter URL" należy podstawić zdefiniowane id do adresu URL żądania w formacie {id} np. http://localhost/{parametr}
W przypadku parametru typu "Parametr Body" zdefiniowane id zostanie użyte jako klucz przekazywanych danych w ciele żądania
https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#multipartform-data

Określa wyświetlaną nazwę parametrów wejściowych

Parametr URL - parametr zostanie przekazany w adresie URL

Parametr Body - parametr zostanie przekazany ciele żądania

Warning
Parametrów typu "Parametr Body" nie należy dodawać do żądań typu "GET"!

Opcjonalny

Parametry wyjściowe

Id parametrów wyjściowych

Nazwy parametrów wyjściowych

JsonPath

Określa id parametrów wyjściowych używane w mappingu

Określa wyświetlaną nazwę parametrów wyjściowych

Opcjonalny

Panel

title	Opis

Źródło danych służące do wymiany informacji między systemem PlusWorkflow a systemem SAP.

Panel

title	Parametry

Parametr	Opis	Wartość Domyślna	Typ	Uwagi
Autoryzacja	Zapisany szablon autoryzacji		Lista wyboru	Lista przygotowanych wcześniej konfiguracji połączeń do SAP. Więcej informacji pod linkiem .....
Funkcja	Nazwa wywoływanej funkcji BAPI		Tekst	Obok parametru jest przycisk dzięki któremu można sprawdzić czy dana funkcja istnieje w danym połączeniu SAP
Czas pamięci podręcznej [sekundy]	Czas przechowywania wyników w pamięci serwera dla tych samych paramentów wywoływania. Czas liczony w sekundach	30	Liczba	Im większy czas tym rzadziej będzie odpytywać serwer SAP. Przydatne podczas stosowania paginacji w DC lub dla danych z SAPA które rzadko się zmieniają.
Logowanie parametrów	Wyświetla w logach dodatkowe parametry z którymi została wywołana funkcji. Oraz wyświetla wyniki tej funkcji		Logiczny
Id parametrów wejściowych	Unikalny identyfikator parametru		Tekst	Nie można stosować znaku . (kropki)
Nazwa parametrów wejściowych:	Nazwa wyświetlana parametru wejściowego		Tekst
Nazwa parametru BAPI	Nazwa parametru wejściowego funkcji z BAPI.		Tekst	Gdy parametr jest w strukturze lub w tablicy należy podać z kropką nazwę struktur/parametru a potem parametr docelowy np DOCUMENT_HEADER.NR_DOK (Podczas wywoływania źródła danych parametry tablicowe podaję się jako tekst rozdzielony znakiem średnika
Id parametrów wyjściowych	Unikalny identyfikator parametru		Tekst	Nie można stosować znaku . (kropki)
Nazwy parametrów wyjściowych	Nazwa wyświetlana parametru wyjściowego		Tekst
xPath	Ścieżka typu 'XPath' do node'a, którego wartość ma zostać odczytana. XPath tutorial		Tekst	Przykładowo aby odczytać wartość tablicową należy podać "//TABELA_NAZWA//PARAM"

The parameter allows adding additional headers to the request. The parameter can be used, for example, to force a response from the API in JSON format. In this case, add a row in the described parameter and enter "Accept" in the "Header" field, and "application/json" in the "Value" field.

Image Removed
A properly configured API should return data in JSON format on request with the above header or reply with an error in case this request cannot be answered in JSON format.A path (similar to XPath) used to extract data from the resulting JSON. Documentation for using JsonPath - https://github.com/json-path/JsonPath

Image Removed

English

Info
Instructions for creating data sources in the system - http://192.168.1.52:8081/confluence/pages/viewpage.action?pageId=13272439

The plugin contains the implementation of datasources operating on the RESTful API.

Described data sources allow for read and transfer data between the PlusWorkflow system and an external API using the HTTP protocol methods (GET, POST, etc.).

Info
It is also possible to communicate with the PWFL system's internal API. In this case, use "localhost" in the URL

Image Removed

Configuration description:

Name of the parameter

Description

Optionality

Authorization

Request authorization scheme. If the requested endpoint does not require authorization, leave the field blank. Description of defining authorization templates is HERE.

Optional

Additional headers

Optional

HTTP method

List of HTTP protocol methods. Available methods: GET, HEAD, POST, PUT, DELETE, PATCH. Choose the required request method according to the API documentation.

Required

URL

Endpoint URL to which the request will be sent. If you call an action from the API of the same PlusWorkflow system in which the datasource is configured, the URL must contain the domain "localhost".

Required

Content-Type

The parameter allows defining the format of the data transferred in the body of the request. The parameter is used only if the "Parameters Body" type parameters are among the input parameters. In other cases the value of this parameter does not matter.

Required

Input parameters

Input parameters id

Input parameters names

Input parameters types

Specifies the id of the input parameters.

In the case of a "URL param" parameter, you must substitute the defined id in the URL of the request in the {id} format, e.g.. http://localhost/{parametr}
In the case of a "Body param" parameter, the defined id will be used as the key of the transmitted data in the body of the request
https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types#multipartform-data

Specifies the display name of the input parameters

URL param - the parameter will be passed in the URL

Body param - the parameter will be passed in the request body

Warning
Parameters of type "Body param" should not be added to requests of type "GET"!

Optional

Output parameters

Output parameters id

Output parameters names

JsonPath

Specifies the id of the output parameters used in mapping

Specifies the display name of the output parameters

Optional

Versions Compared

Old Version 2

New Version 3

Key

Wtyczka zawiera implementację źródeł danych operujących na RESTful API.

The plugin contains the implementation of datasources operating on the RESTful API.

Configuration description: