Wiki-Quellcode von Post-Request
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | {{figure image="post_request_de.png" clear="h1"}} | ||
2 | Oberfläche zur Einstellung der Parameter von Aktionen des Typs //POST-Request//. | ||
3 | {{/figure}} | ||
4 | |||
5 | Aktionen des Typs //POST-Request// ermöglichen es, Formulardaten als POST-Request an die angegebene URL zu senden und stellt dadurch eine Universalschnittstelle zu anderen Diensten dar. | ||
6 | |||
7 | == Parameter == | ||
8 | |||
9 | === Details für den POST Request === | ||
10 | |||
11 | ; Sende URL | ||
12 | : Stellt die Adresse dar, an die das //POST-Request// geschickt werden soll. | ||
13 | ; XSL-Template | ||
14 | : In den meisten Fällen wird der externe Dienst, an den das //POST-Request// übertragen wurde, eine Antwort in Form von XML oder HTML zurückliefern. In einigen Fällen kann es notwendig sein, dass diese zur Anzeige gebracht oder in anderen Aktionen weiterverarbeitet werden sollen. Über die Auswahl eines XSL-Templates haben Sie die Möglichkeit, die zurücklieferte Antwort aufzubereiten oder anders zu formatieren. | ||
15 | ; Zeichensatz des Aufrufs | ||
16 | : Legt fest, mit welchem Zeichensatz das //POST-Request// gesendet wird. | ||
17 | ; Zeichensatz der Antwortseite | ||
18 | : Legt fest, mit welchem Zeichensatz die Antwort entgegengenommen werden soll. | ||
19 | ; Als Abschlussseite bereitstellen | ||
20 | : Liefert die Antwort der Aktion an den Client aus. Bei deaktivierter Option wird die Standardantwort von FORMCYCLE ausgeliefert. | ||
21 | |||
22 | {{figure image="post_request_extended_de.png" clear="h1"}} | ||
23 | Erweiterte Oberfläche zur Einstellung der Parameter von Aktionen des Typs //POST-Request//. | ||
24 | {{/figure}} | ||
25 | |||
26 | === Zusätzliche Parameter === | ||
27 | |||
28 | ; Zusätzliche Header | ||
29 | : Hier kann eine Liste von Header hinterlegt werden, die in jedem Fall übertragen werden. | ||
30 | ; Alle Formularwerte übertragen | ||
31 | : Ist die Möglichkeit alle aus dem Formular erfassten Daten weiterzuleiten. Der Name des Formularelementes bzw. der [[Alias>>Formcycle.Designer.Form.ElementProperties.BaseProperties]] ist hierbei der Feldbezeichner innerhalb des //POST-Request//. Der Wert ist die Eingabe aus dem Formular. | ||
32 | [[image:POST_Bezeichner.PNG]] | ||
33 | ; Aliasnamen verwenden (für Formularelemente und Uploads) | ||
34 | : Formularfelder werden mit ihren Formularfeldaliasen anstatt mit den Formularfeldnamen übertragen. | ||
35 | ; Zusätzliche Parameter | ||
36 | : Hier kann eine Liste von Parametern hinterlegt werden, die in jedem Fall übertragen werden. Häufig werden hier zusätzliche statische Informationen hinterlegt, die von dem externen Dienst benötigt werden, oder wenn Feldbezeichner anders als im Formular hinterlegt erwartet werden. | ||
37 | |||
38 | === Dateien zum Request hinzufügen (Multipart-Request) === | ||
39 | |||
40 | ; Dateien | ||
41 | : Auswahl von Dateien die zum Request hinzugefügt werden können. | ||
42 | |||
43 | === Erweiterte Verbindungseinstellungen === | ||
44 | |||
45 | : **HTTP Basic-Authentifizierung** | ||
46 | :; Verwendung der HTTP Basic-Authentifizierung | ||
47 | :: //Name//: Benutzername für die URL | ||
48 | :: //Passwort//: Passwort für den Benutzer | ||
49 | : **Proxy-Server benutzen** | ||
50 | :; Weiterleitung an einen Proxy-Server | ||
51 | :: //Proxy-Server Hostname//: Name des Proxy-Servers | ||
52 | :: //Port//: Port des Proxy-Servers. Standard ist {{code language="none"}}80{{/code}}. | ||
53 | :; Proxy Authentifizierung: Authentifizierung am Proxy-Server | ||
54 | :: //Login//: Benutzername für den Proxy-Server | ||
55 | :: //Passwort//: Passwort für den Proxy-Benutzer | ||
56 | |||
57 | === Ablage der erzeugten Dateien === | ||
58 | |||
59 | ; An den Vorgang anhängen | ||
60 | : Wenn diese Option angewählt wird, werden in dieser Aktion erzeugte Dateien an den Vorgang angehangen. Ansonsten stehen Sie nur innerhalb des Workflows für Aktionen innerhalb der selben Verarbeitungskette zur Verfügung. | ||
61 | |||
62 | == Aktionsplatzhalter == | ||
63 | |||
64 | Aktionen vom Typ //Post-Request// stellen [[Aktionsplatzhalter>>Formcycle.UserInterface.Variables||anchor="HAktionsplatzhalter"]] bereit, welche in darauf folgenden Aktionen verwendet werden können. | ||
65 | |||
66 | === Standardplatzhalter === | ||
67 | |||
68 | ; [%$<Aktionsname>.SUCCESS%] | ||
69 | : Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück. | ||
70 | ; [%$<Aktionsname>.RESULT%] | ||
71 | : Rückgabe aller von der Aktion bereitgestellten Ergebnisse in strukturierter Form. | ||
72 | |||
73 | ; [%$<Aktionsname>.ERROR_CODE%] | ||
74 | : Der geworfene Fehler-Code im Fehlerfall der Aktion. Leer wenn kein Fehler aufgetreten ist. | ||
75 | ; [%$<Aktionsname>.ERROR_MESSAGE%] | ||
76 | : Die geworfene Fehler-Nachricht im Fehlerfall der Aktion. Leer wenn kein Fehler aufgetreten ist. | ||
77 | |||
78 | === Aktionsspezifische Platzhalter === | ||
79 | |||
80 | ; [%$<Aktionsname>.RESULT.redirectUrl%] | ||
81 | : Enthält im Fall einer Weiterleitung die URL zum Ziel | ||
82 | ; [%$<Aktionsname>.RESULT.redirected%] | ||
83 | : Liefert true zurück, wenn die HTTP-Anwort in einer Weiterleitung resultiert, sonst false. | ||
84 | ; [%$<Aktionsname>.RESULT.responseBody%] | ||
85 | : Enthält die Antwort, die durch den ausgelösten POST-Request zurückgeliefert wurde. Im Fall einer Weiterleitung ist dieser Wert leer. | ||
86 | ; [%$<Aktionsname>.RESULT.responseCode%] | ||
87 | : Enthält den zurückgelieferten HTTP-Statuscode | ||
88 | ; [%$<Aktionsname>.RESULT.responseJson%] | ||
89 | : Enthält ein JSON-Objekt oder JSON-Array, wenn es sich bei der HTTP-Antwort nicht um eine Weiterleitung handelt und der content-type des zurückgegebenen Inhalt application/json ist | ||
90 | ; [%$<Aktionsname>.RESULT.responseReasonPhrase%] | ||
91 | : Enthält im Falle eines erfolgreichen POST-Requests die Statusnachricht, wie etwa "OK" oder "Found" | ||
92 | ; [%$<Aktionsname>.RESULT.responseStatusLine%] | ||
93 | : Enthält im Falle eines erfolgreichen POST-Requests die Statusnachricht, wie etwa "OK" oder "Found" | ||
94 | ; [%$<Aktionsname>.ERROR.message%] | ||
95 | : Fehlernachricht, der zurückgeliefert wird, wenn die angebene externe URL-Ressource keinem gültigen Format entspricht, der angebundene Server nicht erreicht werden kann oder keine Antwort zurückliefert, beim Hinzufügen von Dateien zum Post-Request Fehler aufgetretten ist oder die konfiguriert XSLT-Transformation fehlgeschlagen ist. |