| Table of Contents |
|---|
Connectors can be created by using the REST connection. This allows the user to access to a resource. In the following, we will explain the process further. We will create a connector with the REST connection which contains a product list as an example.
Creating a new connector without an authentication
In order to create a connector, please open the page Connector under the Design. Created connector than will be available to use in the Smartform.
...
Connector can be created via plus sign or directly with the REST button:
...
The configuration page allows you to enter the desired connector name. URL which contains the webpage for product information should be entered in the hostname area. HTTP method, limitation for the result size and authentication methods should be selected. →
Result size limits the data to be shown with the entered value.
Cache information can be available by clicking the checkbox.
| Info |
|---|
In our example we used the GET method which you can use for reading the data. You can use other methods available: |
Clicking the “Save” button will save the custom connector.
...
Creating a connector with authentication
If you need an authentication to access a connector URL, you can use either basic authentication or OAuth according to your needs.
Basic Authentication
Basic authentication can be configured via entering the user name and password. In the SAP API, there is an extra configuration feature with the CSRF token. You can configure this feature as well according to your needs.
...
OAuth (Open Authorization)
This authorization method allows you to avoid constant user name and password transfer with a token to secure the access. You can configure this authorization method with user information alongside with the OAuth token information.
...
Using the connector in the smartform
Custom connectors can be used in the smartform. In order to show our example, the product list, in the “Select” element of the smartform, “Connections” section should be opened. The label and the value will be selected from the REST file, which contain information of the products.
...
Parameter
...
Description
...
Example
...
Connection 1
...
Custom connectors can be reached via this drop-down list.
...
Products
...
JSON Path: label
...
Konnektoren können mithilfe der REST-Verbindung erstellt werden. Dadurch kann der Benutzer auf eine Ressource zugreifen. Im Folgenden erläutern wir den Prozess weiter. Wir erstellen einen Konnektor mit der REST-Verbindung, der beispielsweise eine Produktliste enthält.
...
Erstellen eines neuen Konnektors ohne Authentifizierung
Um einen Konnektor zu erstellen, öffnen Sie bitte die Seite Konnektor unter dem Design. Erstellter Konnektor, der in der Smartform verwendet werden kann.
...
Konnektor kann per Pluszeichen oder direkt mit der REST-Taste erstellt werden:
...
Auf der Konfigurationsseite können Sie den gewünschten Konnektornamen eingeben. Die URL, die die Webseite für Produktinformationen enthält, sollte im Hostnamenbereich eingegeben werden. HTTP-Methode, Begrenzung für die Ergebnisgröße und Authentifizierungsmethoden sollten ausgewählt werden.
Die Ergebnisgröße begrenzt die Daten, die mit dem eingegebenen Wert angezeigt werden sollen.
Cache-Informationen können durch Aktivieren des Kontrollkästchens verfügbar sein.
| Info |
|---|
In unserem Beispiel haben wir die GET-Methode verwendet, mit der Sie die Daten lesen können. Sie können andere verfügbare Methoden verwenden: |
Wenn Sie auf die Schaltfläche "Save" klicken, wird der benutzerdefinierte Konnektor gespeichert.
...
Sie können die REST-Verbindung einfach über den Abschnitt "Testing" testen, nachdem Sie den Stecker gespeichert haben.
...
Erstellen eines Konnektors mit Authentifizierung
Wenn Sie eine Authentifizierung für den Zugriff auf eine Connector-URL benötigen, können Sie je nach Bedarf entweder die Standardauthentifizierung oder OAuth verwenden.
Standardauthentifizierung
Die Standardauthentifizierung kann durch Eingabe des Benutzernamens und des Kennworts konfiguriert werden. In der SAP-API gibt es eine zusätzliche Konfigurationsfunktion mit dem CSRF-Token. Sie können diese Funktion auch nach Ihren Bedürfnissen konfigurieren.
...
OAuth (Offene Autorisierung)
Diese Autorisierungsmethode ermöglicht es Ihnen, die ständige Übertragung von Benutzernamen und Kennwörtern mit einem Token zu vermeiden, um den Zugriff zu sichern. Sie können diese Autorisierungsmethode mit Benutzerinformationen zusammen mit den OAuth-Tokeninformationen konfigurieren.
...
Verwenden des Konnektors im Smartformular
Benutzerdefinierte Konnektoren können im Smartformular verwendet werden. Um unser Beispiel, die Produktliste, zu zeigen, sollte im Element "Select" des Smartformulars der Abschnitt "Connections" geöffnet werden. Das Etikett und der Wert werden aus der REST-Datei ausgewählt, die Informationen zu den Produkten enthält.
...
Parameter | Beschreibung | Beispiel | ||
|---|---|---|---|---|
Connection 1 | Benutzerdefinierte Konnektoren können über diese Dropdown-Liste erreicht werden. | Produkte | ||
JSON-Path: label | Dieser Bereich bestimmt den Parameter, der in der Smartform-Dropdown-Liste angezeigt werden soll. |
| ||
JSON-Path: value | This area determines the parameter which will be stored in the databaseDieser Bereich bestimmt den Parameter, der in der Datenbank gespeichert wird. |
|
| Info |
|---|
Die Syntax for JSON path starts with a Leerzeichen aus den Spaltennamen sollten vermieden werden, um die Informationen über JSON zu erreichen. |