| ... |
... |
@@ -18,7
+18,7 @@ |
| 18 |
18 |
|
| 19 |
19 |
))) |
| 20 |
20 |
|
| 21 |
|
-; rest.srv.url (Pflichtangabe) |
|
21 |
+; rest.srv.url (Pflichtangabe) {{id name="bundle_prop_rest_url"/}} |
| 22 |
22 |
: Protokoll, Host und Pfadangabe zu einen regisafe REST Service. (Die hier erforderliche Angabe darf keine konkrete Funktionsreferenz auf eine Funktionsgruppe enthalten.) |
| 23 |
23 |
; rest.srv.connection.timeout |
| 24 |
24 |
: Wert für ein Connection-Timeout in Millisekunden. (Standardwert: 10 Sekunden) |
| ... |
... |
@@ -34,11
+34,11 @@ |
| 34 |
34 |
|
| 35 |
35 |
))) |
| 36 |
36 |
|
| 37 |
|
-; API ID (Pflichtangabe) |
|
37 |
+; API ID (Pflichtangabe) {{id name="bundle_prop_api_id"/}} |
| 38 |
38 |
: Kennung zur Nutzung der IQ-API. |
| 39 |
|
-; Login ID (Pflichtangabe) |
|
39 |
+; Login ID (Pflichtangabe) {{id name="bundle_prop_login_id"/}} |
| 40 |
40 |
: Die Login ID, wird vom regisafe-System vorgegeben. |
| 41 |
|
-; Password (Pflichtangabe) |
|
41 |
+; Password (Pflichtangabe) {{id name="bundle_prop_pwd"/}} |
| 42 |
42 |
: Passwort für das zuvor definierte Login |
| 43 |
43 |
|
| 44 |
44 |
{{/panel}} |
| ... |
... |
@@ -54,6
+54,29 @@ |
| 54 |
54 |
|
| 55 |
55 |
=== Übersteuern der Serverkonfiguration === |
| 56 |
56 |
|
|
57 |
+{{figure image="plugin_srv_config.png"}} |
|
58 |
+Einstellungen zur Übersteuerung global definierter Verbindungsparameter |
|
59 |
+{{/figure}} |
|
60 |
+ |
|
61 |
+In diesem Bereich besteht die Möglichkeit die global am Plugin-Bundle registrierten Eigenschaften für den anzubindenden //regisafe//-Server und dessen Authentifizierungs-Informationen formular-prozess-spezifisch zu übersteuern. |
|
62 |
+Es können Platzhalter (Auswahlmöglichkeit über Button [[image:icon_placeholder.png]]) für einzelne Einstellungen verwendet werden. |
|
63 |
+ |
|
64 |
+; REST-Service URL |
|
65 |
+: Protokoll und Host zum Zugriff auf die //regisafe// IQ-API. (z.B. //https:~/~/my.regisafe-server.com/iqAPI//) |
|
66 |
+: Übersteuert den global definierten Parameter **[[rest.srv.url>>doc:||anchor="bundle_prop_rest_url"]]**. |
|
67 |
+; API-ID |
|
68 |
+: Die ID, welche die Kennung zur Nutzung der //regisafe//-API repräsentiert. |
|
69 |
+: Übersteuert den global definierten Parameter **[[API ID>>doc:||anchor="bundle_prop_api_id"]]**. |
|
70 |
+; Login-ID |
|
71 |
+: Anmeldenamen des Nutzers über den der Zugriff auf den Web-Service erfolgen soll. |
|
72 |
+: Übersteuert den global definierten Parameter **[[Login ID>>doc:||anchor="bundle_prop_login_id"]]**. |
|
73 |
+; Passwort |
|
74 |
+: Passwort zur //Login-ID//. Übersteuert den global definierten Parameter **[[Password>>doc:||anchor="bundle_prop_pwd"]]**. |
|
75 |
+ |
|
76 |
+{{info}} |
|
77 |
+Über den [[image:btn_check.png]] Button kann geprüft werden, ob der Web-Service prinzipiell erreicht werden kann, sowie ob eine Authentifizierung mit den hinterlegten Benutzer-Credentials möglich ist. |
|
78 |
+{{/info}} |
|
79 |
+ |
| 57 |
57 |
=== Allgemeine Rückgabeparameter === |
| 58 |
58 |
|
| 59 |
59 |
{{figure image="plugin_result.png"}} |
| ... |
... |
@@ -60,12
+60,10 @@ |
| 60 |
60 |
Konfiguration der Plugin Rückgabedaten (Plugin-Result Platzhalter) |
| 61 |
61 |
{{/figure}} |
| 62 |
62 |
|
| 63 |
|
-((( |
| 64 |
64 |
In diesem Bereich werden die vom Plugin als Ergebnis des //regisafe// Service-Aufrufs zurück gelieferten Parameter aufgeführt. |
| 65 |
65 |
Für die einzelnen Parameter kann ein Alias vergeben werden. |
| 66 |
66 |
In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden. |
| 67 |
67 |
Der Platzhalter wird dabei nach dem folgenden Muster gebildet: |
| 68 |
|
-))) |
| 69 |
69 |
|
| 70 |
70 |
{{code language="javascript"}} |
| 71 |
71 |
[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%] |
| ... |
... |
@@ -76,7
+76,6 @@ |
| 76 |
76 |
und an anderer Stelle, zum Beispiel im Text einer E-Mail-Aktion, mittels {{code language="none"}}Ctrl+V{{/code}} eingefügt werden. |
| 77 |
77 |
{{/info}} |
| 78 |
78 |
|
| 79 |
|
- |
| 80 |
80 |
; ResultCode |
| 81 |
81 |
: Das Ergebnis der Ausführung der Plugin-Aktion wird in Form eines Statuscode zurück geliefert. |
| 82 |
82 |
: Dabei definiert der Statuscode **"0"**, dass das Plugin fehlerfrei ausgeführt werden konnte. |
| ... |
... |
@@ -100,3
+100,4 @@ |
| 100 |
100 |
=== 1.0.0 === |
| 101 |
101 |
|
| 102 |
102 |
* initiale Anbindung der //regisafe// Dokument-Upload-Schnittstelle |
|
123 |
+{{/info}} |