Wiki-Quellcode von PDF-Utils-Plugin

Zeige letzte Bearbeiter
1 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/fc-plugin-pdf-utils&fileid=3371||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
2
3 {{info}}
4 Bitte verwenden Sie für {{formcycle/}} Version 6 das Plugin in **Version 2.x.x**.
5 {{/info}}
6
7 {{info}}
8 Bitte verwenden Sie für {{formcycle/}} Version 7 das Plugin ab **Version 3.0.0**.
9 {{/info}}
10
11 {{content/}}
12
13 Das kostenpflichtige Plugin-Bundle //fc-plugin-pdf-utils// stellt jeweils eine [[Aktion>>doc:Formcycle.Designer.Workflow.Actions.WebHome]] bereit, mit der
14
15 * ein PDF-Dokument signiert oder verschlüsselt werden kann.
16 * geprüft werden kann, ob ein PDF-Dokument verschlüsselt ist.
17 * ein vorhandenes PDF-Dokument in das PDF/A-Format (oder ein anderes PDF-Format) umgewandelt werden kann.
18 * mehrere PDF-Dokumente zu einem PDF-Dokument zusammengefügt werden können.
19
20 == Installation und Konfigurations ==
21
22 Das Plugin kann als Mandant-Plugin oder System-Plugin installiert werden. Eine Anleitung zur Installation von Plugins finden Sie [[hier>>doc:Formcycle.UserInterface.Client.Plugins]].
23
24 {{figure image="1_Pluginparameter.png"}}
25 Eine Liste der Pluginparameter in der Oberfläche.
26 {{/figure}}
27
28
29 {{html wiki="true"}}
30 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='Eine Liste der Pluginparameter in der Oberfläche.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='1_Pluginparameter.png' width='300' group='$height' group='$group' title='Eine Liste der Pluginparameter in der Oberfläche.'/}}<div class='xm-figure-caption'>Eine Liste der Pluginparameter in der Oberfläche.</div></div></div>
31 {{/html}}
32
33
34 Nach der Installation des Plugins können die folgenden Parameter konfiguriert werden. Es müssen nicht zwingend alle Parameter konfiguirert sein, sondern nur diejenigen, welche für die geplante Verwendung benötigt werden.
35
36
37 ; enable.producer.set.applicationname
38 : Legt fest, ob die Metadaten "producer" und "creator" in erzeugten PDFs mit dem Namen der Anwendung gefüllt werden sollen. Standardwert: **true**
39 ; enable.producer.action.properties
40 : Legt fest, ob die Metadaten "producer" und "creator" innerhalb der jeweiligen Aktionen einzeln konfiguriert werden können. Standardwert: **false**
41 ; pdf.sign.cert.pwd
42 : Mit diesem Parameter kann ein globales Passworet gesetzt werden, welches als Standardpasswort für alle Aktionen zum Signieren von PDFs verwendet wird.
43 ; pdf.sign.timestampserver.use
44 : Legt fest, ob ein globaler Zeitserver für alle Aktionen zum Signieren von PDFs verwendet werden soll. Standardwert: **false**
45 ; pdf.sign.timestampserver.url
46 : Legt die URL fest, unter der ein für alle Aktionen zum Signieren von PDFs verwendeter globaler Zeitserver erreicht werden kann. Die Antwort des Zeitservers muss der RFC3161 entsprechen. Standardwert: **{{html}}http://timestamp.apple.com/ts01{{/html}}**
47 ; pdf.sign.timestampserver.usr
48 : Optionaler Parameter, mit dem ein Benutzername angegeben werden kann, welcher für den Zugriff auf den oben konfigurierten globalen Zeitserver benötigt wird.
49 ; pdf.sign.timestampserver.pwd
50 : Optionaler Parameter, mit dem ein Passwort angegeben werden kann, welches für den Zugriff auf den oben konfigurierten globalen Zeitserver benötigt wird.
51
52 Nachdem in der Liste der Parameter Änderungen vorgenommen wurden, muss in der Oberfläche rechts unten auf die Schaltfläche //Speichern// geklickt werden, um die Änderungen zu übernehmen. Anschließend wir das Plugin mit den neuen Parametern neu initialisiert, was einige Sekunden dauern kann.
53
54 == PDF-Verschlüsselung prüfen ==
55
56 {{figure width="600" image="5_Optionen_Check_PDF_Encryption.png"}}
57 Hier wird geprüft, ob das PDF-Dokument //Selbstauskunft.pdf// verschlüsselt ist. Falls nicht, dann kann das Dokument in ein PDF-A-Dokument umgewandelt werden. Andernfalls wird eine Warnung an den Fachbereich gesendet.
58 {{/figure}}
59
60 Hier handelt es sich um eine neue Bedingung im Workflow, mit der geprüft werden kann, ob ein PDF-Dokument verschlüsselt ist. Je nachdem, wie diese Bedingung ausfällt, können dann in verschiedene weitere Aktionen ausgeführt werden. Hierzu werden die entsprechenden Aktionen in eine der beiden Zweige der Bedingung geschoben.
61
62 In der Konfiguration der Bedingung muss das PDF-Dokument ausgewählt werden, bei dem geprüft werden soll, ob es verschlüsselt ist.
63
64 == PDF verschlüsseln ==
65
66 {{figure width="600" image="6_Optionen_Encrypt_PDF.png"}}
67 Hier wird PDF-Dokument //Selbstauskunft.pdf// verschlüsselt und dem Antragssteller per Download zugestellt.
68 {{/figure}}
69
70 Mit dieser Aktion kann ein PDF-Dokument verschlüsselt werden. In der Konfiguration wird ein Datei ausgewählt, die Aktion erzeugt dann ein neues PDF-Dokument, welches passwortgeschützt ist. Das ausgewählte Originaldokument wird dabei nicht verändert.
71
72 Bei einem PDF-Dokument ist es möglich, nur das Betrachten oder sowohl das Betrachten und Bearbeiten des PDF-Dokuments mit einem Passwort zu schützen. Prinzipiell erlaubt es ein PDF-Dokument auch, verschiedene Passwörter für das Betrachten und das Bearbeiten zu setzen. Diese Aktion setzt das gleiche Passwort für das Betrachten und das Bearbeiten.
73
74 Falls das PDF-Dokument bereits verschlüsselt ist, wird keine erneute Verschlüsselung durchgeführt.
75
76 === PDF-Dateien ===
77
78 ; Passwort zum Verschlüsseln
79 : Hier wird das Passwort eingegeben, welches für die Verschlüsselung verwendet wird. Um das so erzeugte PDF-Dokument
80 ; Dateien
81 : Hier werden die PDF-Dokumente ausgewählt, welche verschlüsselt werden sollen. Es ist möglich, mehrere PDF-Dokumente gleichzeitig zu verschlüsseln. Ist ein PDF-Dokument bereits verschlüsselt ist, wird keine erneute Verschlüsselung durchgeführt.
82
83 === Ablage der erzeugten Dateien ===
84
85 ; Ausgabedateiname
86 : Hier kann festgelegt werden, wie der Dateiname des erzeugten verschlüsselten PDF-Dokuments gewählt wird. Ist kein Wert eingetragen, wird der Name des zu verschlüsselnden PDF-Dokuments genommen. Die Dateiendung //.pdf// wird automatisch angefügt, falls noch nicht vorhanden.
87 ; An den Vorgang anhängen
88 : Die in dieser Aktion erzeugte Datei ist standardmäßig nur innerhalb der Workflow-Ausführung verfügbar. Wenn diese Option aktiviert wird, kann die durch die Aktion erzeugte Datei an den Vorgang angehangen werden.
89
90 == PDFs vereinigen ==
91
92 {{figure width="600" image="2_Optionen_Merge_PDF.png"}}
93 Optionen mit denen eine Aktion vom Typ //PDF-Utils:Merge PDF// in der Statusverarbeitung konfiguriert werden kann.
94 {{/figure}}
95
96 Mit dieser Aktion können mehrere PDF-Dokumente in ein PDF-Dokument zusammengeführt werden. Die folgenden Optionen werden zum Konfigurieren der Plugin-Aktion verwendet:
97
98 === Allgemeine Einstellungen ===
99
100 ; PDFs
101 : Hier können die PDFs ausgewählt werden, welche im Ausgabedokument zusammengeführt werden. Zudem kann die die Reihenfolge bestimmt werden.
102 :
103 : Es können dazu einzelne oder mehrere PDFs in der rechten oder linken Liste ausgewählt und mittels den zwischen den Listen befindlichen Schaltflächen mit dem nach rechts bzw. links zeigenden Pfeil zum zu erstellenden Dokument hinzugefügt oder entfernt werden. Alternativ können mit den doppelten Pfeilen alle vorhandenen Elemente aus einer der Liste in die andere verschoben werden. In der Liste "Ausgewählt" können selektierte Elemente innerhalb der Listemit den rechts davon befindlichen Schaltflächen nach oben oder nach unten verschoben werden. Auch per Drag&Drop können die PDFs zwischen und innerhalb von Listen verschoben werden.
104 :
105 : Es können nur Dokumente aus der Status- und Aktionsverarbeitung ausgewählt werden. Um Dateien aus Uploadelementen im Formular zu verwenden, ist es daher nötig, diese mit einer Aktion vom Typ [[//Upload bereitstellen//>>doc:Formcycle.Designer.Workflow.LegacyWorkflow.Actions.ProvideUpload]] für die Verwendung bereitzustellen.
106 ; Name der Ausgabedatei
107 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird. Die Dateiendung //.pdf// wird automatisch angefügt, falls noch nicht vorhanden.
108
109 === Metadaten ===
110
111 Unter diesem Punkt können Metadaten des zuerszeugenden PDF-Dokuments festgelegt werden. Dabei können durch die Nutzung von Platzhaltern auch erfasste Inhalte aus dem Formular verwendet werden.
112
113 ; Titel
114 : Inhalt des Metadatenfeldes //title// im erzeugten PDF.
115 ; Betreff
116 : Inhalt des Metadatenfeldes //subject// im erzeugten PDF.
117 ; Schlagwörter
118 : Inhalt des Metadatenfeldes //keywords// im erzeugten PDF.
119 ; Autor
120 : Inhalt des Metadatenfeldes //author// im erzeugten PDF.
121
122 Die beiden folgenden Optionen sind nur dann verfügbar, wenn der Pluginparameter **enable.producer.action.properties** auf **true** gesetzt wurde.
123
124 ; Inhalt erstellt mit
125 : Inhalt des Metadatenfeldes //producer// im erzeugten PDF. Falls das Feld leer gelassen wird, wird der Standardwert verwendet, der durch die getroffene Einstellung beim Pluginparameter **enable.producer.set.applicationname** vorgegeben wird.
126 ; Codierungs-Software
127 : Inhalt des Metadatenfeldes //creator// im erzeugten PDF. Falls das Feld leer gelassen wird, wird der Standardwert verwendet, der durch die getroffene Einstellung beim Pluginparameter **enable.producer.set.applicationname** vorgegeben wird.
128
129 === Ablage der erzeugten Dateien ===
130
131 ; An den Vorgang anhängen
132 : Die in dieser Aktion erzeugte Datei ist standardmäßig nur innerhalb der Workflow-Ausführung verfügbar. Wenn diese Option aktiviert wird, kann die durch die Aktion erzeugte Datei an den Vorgang angehangen werden.
133
134 == PDF-A-Konvertierung ==
135
136 {{figure width="600" image="3_Optionen_PDF_to_PDF_A.png"}}
137 Optionen mit denen eine Aktion vom Typ //PDF-Utils:PDF to PDF/A// in der Statusverarbeitung konfiguriert werden kann.
138 {{/figure}}
139
140
141 {{html wiki="true"}}
142 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='Optionen mit denen eine Aktion vom Typ PDF-Utils:PDF to PDF/A in der Statusverarbeitung konfiguriert werden kann.'><div class='xm-figure-inner' style='width:610px'>{{lightbox image='3_Optionen_PDF_to_PDF_A.png' width='600' group='$height' group='$group' title='Optionen mit denen eine Aktion vom Typ PDF-Utils:PDF to PDF/A in der Statusverarbeitung konfiguriert werden kann.'/}}<div class='xm-figure-caption'>Optionen mit denen eine Aktion vom Typ //PDF-Utils:PDF to PDF/A// in der Statusverarbeitung konfiguriert werden kann.</div></div></div>
143 {{/html}}
144
145
146 Mit dieser Aktion können mehrere PDF-Dokumente in ein PDF-Dokument zusammengeführt werden. Die folgenden Optionen werden zum Konfigurieren der Plugin-Aktion verwendet:
147
148
149 === PDF/A Einstellungen ===
150
151 ; PDF
152 : Auswahl des Quelldokuments für die Umwandlung. Es können nur Dokumente aus der Status- und Aktionsverarbeitung ausgewählt werden. Um Dateien aus Uploadelementen im Formular zu verwenden, ist es daher nötig, diese mit einer Aktion vom Typ [[//Upload bereitstellen//>>doc:Formcycle.Designer.Workflow.LegacyWorkflow.Actions.ProvideUpload]] für die Verwendung bereitzustellen.
153 ; Format
154 : Format des zu erzeugenden PDF-Dokuments. Standardmäßig wird //PDF/A-3b// verwendet. Neben den PDF/A-Formaten können als Augabeformat auch normale PDF-Versionen ausgewählt werden.
155 ; Name der Ausgabedatei
156 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird. Die Dateiendung //.pdf// wird automatisch angefügt, falls noch nicht vorhanden.
157
158 === Metadaten ===
159
160 Unter diesem Punkt können Metadaten des zuerszeugenden PDF-Dokuments festgelegt werden. Dabei können durch die Nutzung von Platzhaltern auch erfasste Inhalte aus dem Formular verwendet werden.
161
162 ; Titel
163 : Inhalt des Metadatenfeldes //title// im erzeugten PDF.
164 ; Betreff
165 : Inhalt des Metadatenfeldes //subject// im erzeugten PDF.
166 ; Schlagwörter
167 : Inhalt des Metadatenfeldes //keywords// im erzeugten PDF.
168 ; Autor
169 : Inhalt des Metadatenfeldes //author// im erzeugten PDF.
170
171 Die beiden folgenden Optionen sind nur dann verfügbar, wenn der Pluginparameter **enable.producer.action.properties** auf **true** gesetzt wurde.
172
173 ; Inhalt erstellt mit
174 : Inhalt des Metadatenfeldes //producer// im erzeugten PDF. Falls das Feld leer gelassen wird, wird der Standardwert verwendet, der durch die getroffene Einstellung beim Pluginparameter **enable.producer.set.applicationname** vorgegeben wird.
175 ; Codierungs-Software
176 : Inhalt des Metadatenfeldes //creator// im erzeugten PDF. Falls das Feld leer gelassen wird, wird der Standardwert verwendet, der durch die getroffene Einstellung beim Pluginparameter **enable.producer.set.applicationname** vorgegeben wird.
177
178 === Ablage der erzeugten Dateien ===
179
180 ; Name der Ausgabedatei
181 : Dateiname, der für die erzeugte Datei verwendet werden soll. Die Dateiendung //.pdf// wird automatisch angefügt, falls noch nicht vorhanden.
182 ; An den Vorgang anhängen
183 : Die in dieser Aktion erzeugte Datei ist standardmäßig nur innerhalb der Workflow-Ausführung verfügbar. Wenn diese Option aktiviert wird, kann die durch die Aktion erzeugte Datei an den Vorgang angehangen werden.
184
185 == PDF signieren ==
186
187 {{figure width="600" image="4_Optionen_Sign_PDF.png"}}
188 Optionen mit denen eine Aktion vom Typ //PDF-Utils:Sign PDF// in der Statusverarbeitung konfiguriert werden kann.
189 {{/figure}}
190
191
192 {{html wiki="true"}}
193 <div class='xm-figure xm-float-right xm-clear-h2' data-alt='Optionen mit denen eine Aktion vom Typ PDF-Utils:Sign PDF in der Statusverarbeitung konfiguriert werden kann.'><div class='xm-figure-inner' style='width:610px'>{{lightbox image='4_Optionen_Sign_PDF.png' width='600' group='$height' group='$group' title='Optionen mit denen eine Aktion vom Typ PDF-Utils:Sign PDF in der Statusverarbeitung konfiguriert werden kann.'/}}<div class='xm-figure-caption'>Optionen mit denen eine Aktion vom Typ //PDF-Utils:Sign PDF// in der Statusverarbeitung konfiguriert werden kann.</div></div></div>
194 {{/html}}
195
196
197 Mit dieser Aktion können PDF-Dokumente signiert werden. Es ist zudem möglich, einen Stempel in das Dokument eizufügen. Die folgenden Optionen werden zum Konfigurieren der Plugin-Aktion verwendet:
198
199
200 === Zu Signierendes Dokument ===
201
202 ; PDF
203 : Auswahl des PDF-Dokuments, welches signiert werden soll.
204 ; Name der Ausgabedatei
205 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
206
207 === Signierungsdetails ===
208
209 ; Elektronische Signatur (Zertifikat .p12 oder .pfx)
210 : Auswahl einer Zertifikatsdatei, welche für das Signieren des PDF-Dokuments verwendet werden soll. Die Datei muss im [[Mandant>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]] oder im [[Formular>>doc:Formcycle.UserInterface.MyForms.Files]] hinterlegt sein.
211 ; Passwort
212 : Passwort des Zertifikats.
213 ; Behörde
214 : Optionaler Name der Person oder Behörde, die das Dokument unterzeichnet.
215 ; Kontakt
216 : Optionale Informationen des Unterzeichners, mit denen ein Empfänger den Unterzeichner kontaktieren kann, um die Signatur zu überprüfen.
217 ; Grund
218 : Optionaler Grund für die Unterzeichung, z.B. //ich bin damit einverstanden//.
219 ; Ort
220 : Optionale Angabe des Hostnamen oder des physichen Ortes der Unterzeichnung, z.B. //pro.form.cloud//.
221
222 === Zeitstempelserver ===
223
224 Hier kann ein Zeitstempelserver konfiguriert werden, der die Zeit für Signieren des PDFs bereitstellt. Zunächst ist nur die folgende Option sichtbar:
225
226 ; Externen Zeitstempelserver verwenden
227 : Legt fest, ob ein externer Zeitstempelserver für die Signierung des PDF-Dokuments verwendet werden soll.
228
229 Wenn die Option //Externen Zeitstempelserver verwenden// aktiviert wurde, werden die folgenden Eingabefelder sichtbar:
230
231 ; Zeitstempel-Server (Antwort muss der RFC3161 entsprechen)
232 : Legt die URL fest, unter der ein für alle Aktionen zum Signieren von PDFs verwendeter globaler Zeitserver erreicht werden kann. Die Antwort des Zeitservers muss der RFC3161 entsprechen. Wenn an dieser Stelle nichts eingetragen wird und ein globaler Zeitstempelserver konfiguriert wurde, wird dieser verwendet.
233 ; Zeitstempelserver Benutzername
234 : Optionaler Parameter, mit dem ein Benutzername angegeben werden kann, welcher für den Zugriff auf den oben konfigurierten Zeitserver benötigt wird.
235 ; Zeitstempelserver Passwort
236 : Optionaler Parameter, mit dem ein Passwort angegeben werden kann, welches für den Zugriff auf den oben konfigurierten Zeitserver benötigt wird.
237
238 === Stempel ===
239
240 Über diese Optionen ist es möglich im signierten PDF-Dokument einen virtuellen Stempel einzufügen. Dabei können Stempelinhalt, Position und Größe angepasst werden.
241
242 Zunächst ist nur die folgende Option sichtbar:
243
244 ; Einen virtuellen Stempel auf das Dokument setzen
245 : Legt fest, ob ein virtuellen Stempel in das signierte PDF-Dokument eingefügt werden soll.
246
247 Wenn die Option //Einen virtuellen Stempel auf das Dokument setzen// aktiviert wurde, werden die folgenden Eingabefelder sichtbar:
248
249 ; Bilddatei
250 : Auswahl einer Bilddatei, welche im signierten PDF eingefügt werden soll. Die Datei muss im [[Mandant>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]] oder im [[Formular>>doc:Formcycle.UserInterface.MyForms.Files]] hinterlegt sein.
251 ; Position von links (in Pixel)
252 : Horizontal Position des Stemples im signierten PDF in Pixel augehend vom linken Blattrand.
253 ; Position von unten (in Pixel)
254 : Vertikale Position des Stemples im signierten PDF in Pixel augehend vom unteren Blattrand.
255 ; Breite des Stemples (in Pixel)
256 : Breite des Stemples im signierten PDF in Pixel.
257 ; Höhe des Stemples (in Pixel)
258 : Höhe des Stemples im signierten PDF in Pixel.
259
260 === Ablage der erzeugten Dateien ===
261
262 ; Name der Ausgabedatei
263 : Dateiname, der für die erzeugte Datei verwendet werden soll. Die Dateiendung //.pdf// wird automatisch angefügt, falls noch nicht vorhanden.
264 ; An den Vorgang anhängen
265 : Die in dieser Aktion erzeugte Datei ist standardmäßig nur innerhalb der Workflow-Ausführung verfügbar. Wenn diese Option aktiviert wird, kann die durch die Aktion erzeugte Datei an den Vorgang angehangen werden.