Wiki-Quellcode von regisafe DMS-Plugin

Zeige letzte Bearbeiter
1 {{content/}}
2
3 Über das kostenpflichtige Regisafe DMS Plugin ist es möglich Dokumente aus {{formcycle/}} an das **D**okumenten **M**anagement **S**ystem //regisaf//e zu übergeben. Das Plugin nutzt dabei die vom //regisafe //System bereitgestellte Webservice-Schnittstelle.
4
5 {{panel title="Konfiguration der Verbindungseinstellungen zum regisafe System" initial="hidden" triggerable="true"}}
6
7 {{figure image="plugin_bundle_config.png"}}
8 Globale Einstellungen am Plugin-Bundle
9 {{/figure}}
10
11 (((
12 Die nachfolgenden Einstellungen sind durch einen Administrator, der die Rechte zum Konfigurieren von Plugins besitzt, vorzunehmen.
13 )))
14
15 (((
16 Folgende Eigenschaften für die Anbindung des regisafe Systems können definiert werden:
17
18
19 )))
20
21 ; rest.srv.url (Pflichtangabe) {{id name="bundle_prop_rest_url"/}}
22 : Protokoll, Host und Pfadangabe zu einen regisafe REST Service. (Die hier erforderliche Angabe darf keine konkrete Funktionsreferenz auf eine Funktionsgruppe enthalten.)
23 ; rest.srv.connection.timeout
24 : Wert für ein Connection-Timeout in Millisekunden. (Standardwert: 10 Sekunden)
25 ; rest.srv.read.timeout
26 : Wert für ein Read-Timeout in Millisekunden. (Standardwert: 30 Sekunden)
27 ; rest.srv.proxy.host
28 : Die Host-Angabe, bei Kommunikation über einen Proxy-Server.
29 ; rest.srv.proxy.port
30 : Die Port-Angabe, bei Kommunikation über einen Proxy-Server.
31
32 (((
33 **Konfiguration der Authentifizierungsdaten**
34
35 )))
36
37 ; API ID (Pflichtangabe) {{id name="bundle_prop_api_id"/}}
38 : Kennung zur Nutzung der IQ-API.
39 ; Login ID (Pflichtangabe) {{id name="bundle_prop_login_id"/}}
40 : Die Login ID, wird vom regisafe-System vorgegeben.
41 ; Password (Pflichtangabe) {{id name="bundle_prop_pwd"/}}
42 : Passwort für das zuvor definierte Login
43
44 {{/panel}}
45
46 == Aktions-Plugin //regisafe:Dokument hochladen// ==
47
48 Für die Übermittlung von Dokumenten an das //regisafe//-DMS steht das Aktions-Plugin **regisafe:Dokument hochladen** zur Verfügung.
49 Dieses ermöglicht es, Dateien und zugehörige Metadaten an das DMS zu übermitteln. Anhand der mitgelieferten Metadaten kann die entsprechende Datei dann auf Seiten von //regisafe// weiterverarbeitet werden.
50
51 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
52
53 === Festlegung der zu übertragenden Datei und ihrer Metadaten ===
54
55 {{figure image="upl_plugin_config.png"}}
56 Konfigurationsmöglichkeiten für die zu übertragende Datei und deren Metadaten
57 {{/figure}}
58
59 Über den Parameter **Datei** wird die Datei, welche an das //regisafe//-System übertragen werden soll, festgelegt. Diese kann aus einer datei-bereitstellenden Aktion oder aus einem Formular-Upload-Element stammen. Werden zum Plugin Ausführungszeitpunkt mehrere Dateien ermittelt, beispielsweise weil ein zugeordnetes Formular-Upload-Element dynamisch ist, so werden alle ermittelten Dateien zu einer Zip-Datei zusammengefasst und diese wird an //regisafe// übermittelt.
60
61 Über den Parameter **Dokument ID** kann eine eindeutige ID für das Dokument in //regisafe// definiert werden. Um für ein vorhandenes Dokument eine neue Version zu übermitteln, muss die "Dokument-ID" des zu ändernden Dokuments übergeben werden.
62 Die Länge der ID darf maximal 128 Zeichen sein, wobei die Zeichen beliebig sein können.
63 Ist keine ID festgelegt, so wird das Dokument als neues Dokument im //regisafe//-System abgelegt und die dann im //regisafe//-System erzeugte ID zurück geliefert.
64
65 In der Tabelle **Metadaten Definition** erfolgt die Festlegung der, mit dem Dokument, zu übermittelnden Metadaten.
66
67 Über den[[image:icon_add.png]]-Button können der Tabelle einzelne Metadaten Definitionen hinzugefügt werden.
68 Für ein einzelnes Feld sind dabei //Feld-ID//, und (zu übermittelnder) //Wert// festzulegen.
69 Diese Einstellungen haben folgende Bedeutung:
70
71 ; Feld ID
72 : Enthält den Namen der Variablen, wie er auf Seiten von //regsiafe// als übermitteltes Metadatum angesprochen werden kann.
73 ; Wert
74 : Enthält den an //regisafe// zu übermittelnden Wert. Dieser kann aus Platzhalter{{{(n)}}} oder fest hinterlegten Werten bestehen.
75 : Wird zur Laufzeit kein Wert ermittelt, weil beispielsweise ein Platzhalter keinen Wert referenziert, dann wird dieses //Feld// von der Übermittlung ausgenommen.
76
77 Über den [[image:icon_update.png]]-Button können alle im aktuellen Formular vorhandenen Formular-Elemente als Metadaten Definitionen hinzugefügt werden, wenn Sie noch nicht vorhanden sind.
78 Der Identifikator für bereits vorhandene Elemente ist dabei die Feld-ID, welche mit den Formular-Elementname abgeglichen wird. 
79
80 === Übersteuern der Serverkonfiguration ===
81
82 {{figure image="plugin_srv_config.png"}}
83 Einstellungen zur Übersteuerung global definierter Verbindungsparameter
84 {{/figure}}
85
86 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.
87 Es können Platzhalter (Auswahlmöglichkeit über Button [[image:icon_placeholder.png]]) für einzelne Einstellungen verwendet werden.
88
89 ; REST-Service URL
90 : Protokoll und Host zum Zugriff auf die //regisafe// IQ-API. (z.B. //https:~/~/my.regisafe-server.com/iqAPI//)
91 : Übersteuert den global definierten Parameter **[[rest.srv.url>>doc:||anchor="bundle_prop_rest_url"]]**.
92 ; API-ID
93 : Die ID, welche die Kennung zur Nutzung der //regisafe//-API repräsentiert.
94 : Übersteuert den global definierten Parameter **[[API ID>>doc:||anchor="bundle_prop_api_id"]]**.
95 ; Login-ID
96 : Anmeldenamen des Nutzers über den der Zugriff auf den Web-Service erfolgen soll.
97 : Übersteuert den global definierten Parameter **[[Login ID>>doc:||anchor="bundle_prop_login_id"]]**.
98 ; Passwort
99 : Passwort zur //Login-ID//. Übersteuert den global definierten Parameter **[[Password>>doc:||anchor="bundle_prop_pwd"]]**.
100
101 {{info}}
102 Ü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.
103 {{/info}}
104
105 === Allgemeine Rückgabeparameter ===
106
107 {{figure image="plugin_result.png"}}
108 Konfiguration der Plugin Rückgabedaten (Plugin-Result Platzhalter)
109 {{/figure}}
110
111 In diesem Bereich werden die vom Plugin als Ergebnis des //regisafe// Service-Aufrufs zurück gelieferten Parameter aufgeführt.
112 Für die einzelnen Parameter kann ein Alias vergeben werden.
113 In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
114 Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
115
116 {{code language="javascript"}}
117 [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
118 {{/code}}
119
120 {{info}}
121 Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
122 und an anderer Stelle, zum Beispiel im Text einer E-Mail-Aktion, mittels {{code language="none"}}Ctrl+V{{/code}} eingefügt werden.
123 {{/info}}
124
125 ; ResultCode
126 : Das Ergebnis der Ausführung der Plugin-Aktion wird in Form eines Statuscode zurück geliefert.
127 : Dabei definiert der Statuscode **"0"**, dass das Plugin fehlerfrei ausgeführt werden konnte.
128 : Im Fehlerfall werden unterschiedliche Statuscodes zurück geliefert, welche die folgenden Bedeutungen haben:
129 :; 11:
130 :: Es konnten keine Datei für eine Übermittlung an //regisafe// ermittelt werden.
131 :: (Prüfen Sie bitte die Einstellungen im Bereich **Datei** auf die Existenz einer Datei zum Zeitpunkt der Plugin-Ausführung)
132 :; 30:
133 :: Es konnte keine Verbindung zum Service unter dem URL '//<URL des angefragten Service>//' aufgebaut werden.
134 :; 31:
135 :: Der Serviceaufruf lieferte folgenden Fehler: //<Detaillierte Fehlerinformationen die vom Webservice zurück geliefert wurde>//
136 :; 40:
137 :: In FORMCYCLE ist ein nicht näher spezifizierter Fehler aufgetreten: //<Platzhalter für nähere Fehlerbeschreibung>//
138 ; ResultMessage
139 : Eine zum Statuscode zugehörige Meldung
140 ; ResultDocID
141 : Die vom Webservice zurückgelieferte Dokument-ID, unter welcher die übertragene Datei im //regisafe//-System abgelegt wurde. 
142
143 == Versionshistorie ==
144
145 === 1.0.0 ===
146
147 * initiale Anbindung der //regisafe// Dokument-Upload-Schnittstelle
148 ~{~{/info}}

Navigation

Copyright 2000-2025