Wiki-Quellcode von regisafe DMS-Plugin

Zeige letzte Bearbeiter
1 {{content/}}
2
3 Über das 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)
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)
38 : Kennung zur Nutzung der IQ-API.
39 ; Login ID (Pflichtangabe)
40 : Die Login ID, wird vom regisafe-System vorgegeben.
41 ; Password (Pflichtangabe)
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 === Übersteuern der Serverkonfiguration ===
56
57 === Allgemeine Rückgabeparameter ===
58
59 {{figure image="plugin_result.png"}}
60 Konfiguration der Plugin Rückgabedaten (Plugin-Result Platzhalter)
61 {{/figure}}
62
63 (((
64 In diesem Bereich werden die vom Plugin als Ergebnis des //regisafe// Service-Aufrufs zurück gelieferten Parameter aufgeführt.
65 Für die einzelnen Parameter kann ein Alias vergeben werden.
66 In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
67 Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
68 )))
69
70 {{code language="javascript"}}
71 [%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
72 {{/code}}
73
74 {{info}}
75 Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
76 und an anderer Stelle, zum Beispiel im Text einer E-Mail-Aktion, mittels {{code language="none"}}Ctrl+V{{/code}} eingefügt werden.
77 {{/info}}
78
79
80 ; ResultCode
81 : Das Ergebnis der Ausführung der Plugin-Aktion wird in Form eines Statuscode zurück geliefert.
82 : Dabei definiert der Statuscode **"0"**, dass das Plugin fehlerfrei ausgeführt werden konnte.
83 : Im Fehlerfall werden unterschiedliche Statuscodes zurück geliefert, welche die folgenden Bedeutungen haben:
84 :; 11:
85 :: Es konnten keine Datei für eine Übermittlung an //regisafe// ermittelt werden.
86 :: (Prüfen Sie bitte die Einstellungen im Bereich **Datei** auf die Existenz einer Datei zum Zeitpunkt der Plugin-Ausführung)
87 :; 30:
88 :: Es konnte keine Verbindung zum Service unter dem URL '//<URL des angefragten Service>//' aufgebaut werden.
89 :; 31:
90 :: Der Serviceaufruf lieferte folgenden Fehler: //<Detaillierte Fehlerinformationen die vom Webservice zurück geliefert wurde>//
91 :; 40:
92 :: In FORMCYCLE ist ein nicht näher spezifizierter Fehler aufgetreten: //<Platzhalter für nähere Fehlerbeschreibung>//
93 ; ResultMessage
94 : Eine zum Statuscode zugehörige Meldung
95 ; ResultDocID
96 : Die vom Webservice zurückgelieferte Dokument-ID, unter welcher die übertragene Datei im //regisafe//-System abgelegt wurde. 
97
98 == Versionshistorie ==
99
100 === 1.0.0 ===
101
102 * initiale Anbindung der //regisafe// Dokument-Upload-Schnittstelle

Navigation

Copyright 2000-2025