Wiki-Quellcode von PDF-Utils-Plugin

Verstecke letzte Bearbeiter
spe 14.1 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)
gru 1.1 2
3 {{info}}
awa 7.2 4 Bitte verwenden Sie für {{formcycle/}} Version 6 das Plugin in **Version 2.x.x**.
gru 1.1 5 {{/info}}
6
awa 7.2 7 {{info}}
8 Bitte verwenden Sie für {{formcycle/}} Version 7 das Plugin ab **Version 3.0.0**.
9 {{/info}}
10
gru 1.1 11 {{content/}}
12
gru 6.1 13 Das kostenpflichtige Plugin-Bundle //fc-plugin-pdf-utils// stellt jeweils eine [[Aktion>>doc:Formcycle.Designer.Workflow.Actions.WebHome]] bereit, mit der
gru 3.1 14
awa 7.4 15 * ein PDF-Dokument signiert oder verschlüsselt werden kann.
16 * geprüft werden kann, ob ein PDF-Dokument verschlüsselt ist.
awa 7.3 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.
gru 1.1 19
awa 7.3 20 == Installation und Konfigurations ==
gru 1.1 21
spe 14.1 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]].
gru 1.1 23
spe 14.1 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
gru 1.1 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
spe 14.1 36
awa 7.3 37 ; enable.producer.set.applicationname
gru 1.1 38 : Legt fest, ob die Metadaten "producer" und "creator" in erzeugten PDFs mit dem Namen der Anwendung gefüllt werden sollen. Standardwert: **true**
awa 7.3 39 ; enable.producer.action.properties
gru 1.1 40 : Legt fest, ob die Metadaten "producer" und "creator" innerhalb der jeweiligen Aktionen einzeln konfiguriert werden können. Standardwert: **false**
awa 7.3 41 ; pdf.sign.cert.pwd
gru 1.1 42 : Mit diesem Parameter kann ein globales Passworet gesetzt werden, welches als Standardpasswort für alle Aktionen zum Signieren von PDFs verwendet wird.
awa 7.3 43 ; pdf.sign.timestampserver.use
gru 1.1 44 : Legt fest, ob ein globaler Zeitserver für alle Aktionen zum Signieren von PDFs verwendet werden soll. Standardwert: **false**
awa 7.3 45 ; pdf.sign.timestampserver.url
gru 1.1 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}}**
awa 7.3 47 ; pdf.sign.timestampserver.usr
gru 1.1 48 : Optionaler Parameter, mit dem ein Benutzername angegeben werden kann, welcher für den Zugriff auf den oben konfigurierten globalen Zeitserver benötigt wird.
awa 7.3 49 ; pdf.sign.timestampserver.pwd
gru 1.1 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
awa 13.2 54 == PDF-Verschlüsselung prüfen ==
55
awa 13.4 56 {{figure width="600" image="5_Optionen_Check_PDF_Encryption.png"}}
awa 13.2 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
awa 13.5 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
awa 7.5 64 == PDF verschlüsseln ==
65
awa 13.4 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
awa 13.3 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
awa 13.6 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.
awa 13.3 73
74 Falls das PDF-Dokument bereits verschlüsselt ist, wird keine erneute Verschlüsselung durchgeführt.
75
spe 14.1 76 === PDF-Dateien ===
awa 13.3 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
awa 13.4 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.
awa 13.3 82
awa 13.4 83 === Ablage der erzeugten Dateien ===
84
85 ; Ausgabedateiname
awa 13.9 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.
awa 13.4 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
awa 7.3 90 == PDFs vereinigen ==
gru 1.1 91
awa 13.8 92 {{figure width="600" image="2_Optionen_Merge_PDF.png"}}
awa 13.2 93 Optionen mit denen eine Aktion vom Typ //PDF-Utils:Merge PDF// in der Statusverarbeitung konfiguriert werden kann.
94 {{/figure}}
95
gru 1.1 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
awa 13.4 100 ; PDFs
gru 1.1 101 : Hier können die PDFs ausgewählt werden, welche im Ausgabedokument zusammengeführt werden. Zudem kann die die Reihenfolge bestimmt werden.
spe 14.1 102 :
gru 1.1 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.
spe 14.1 104 :
gru 7.1 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.
awa 13.4 106 ; Name der Ausgabedatei
awa 13.9 107 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird. Die Dateiendung //.pdf// wird automatisch angefügt, falls noch nicht vorhanden.
gru 1.1 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
awa 13.4 113 ; Titel
gru 1.1 114 : Inhalt des Metadatenfeldes //title// im erzeugten PDF.
awa 13.4 115 ; Betreff
gru 1.1 116 : Inhalt des Metadatenfeldes //subject// im erzeugten PDF.
awa 13.4 117 ; Schlagwörter
gru 1.1 118 : Inhalt des Metadatenfeldes //keywords// im erzeugten PDF.
awa 13.4 119 ; Autor
gru 1.1 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
awa 13.4 124 ; Inhalt erstellt mit
gru 1.1 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.
awa 13.4 126 ; Codierungs-Software
gru 1.1 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
awa 13.4 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.
gru 1.1 133
awa 7.3 134 == PDF-A-Konvertierung ==
gru 3.1 135
spe 14.1 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
gru 1.1 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
spe 14.1 148
gru 1.1 149 === PDF/A Einstellungen ===
150
awa 13.4 151 ; PDF
gru 7.1 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.
awa 13.4 153 ; Format
gru 1.1 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.
awa 13.4 155 ; Name der Ausgabedatei
awa 13.9 156 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird. Die Dateiendung //.pdf// wird automatisch angefügt, falls noch nicht vorhanden.
gru 1.1 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
awa 13.4 162 ; Titel
gru 1.1 163 : Inhalt des Metadatenfeldes //title// im erzeugten PDF.
awa 13.4 164 ; Betreff
gru 1.1 165 : Inhalt des Metadatenfeldes //subject// im erzeugten PDF.
awa 13.4 166 ; Schlagwörter
gru 1.1 167 : Inhalt des Metadatenfeldes //keywords// im erzeugten PDF.
awa 13.4 168 ; Autor
gru 1.1 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
awa 13.4 173 ; Inhalt erstellt mit
gru 1.1 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.
awa 13.4 175 ; Codierungs-Software
gru 1.1 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
awa 13.11 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.
awa 13.4 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.
gru 1.1 184
awa 7.3 185 == PDF signieren ==
gru 3.1 186
spe 14.1 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
gru 1.1 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
spe 14.1 199
gru 1.1 200 === Zu Signierendes Dokument ===
201
awa 13.4 202 ; PDF
203 : Auswahl des PDF-Dokuments, welches signiert werden soll.
204 ; Name der Ausgabedatei
gru 1.1 205 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
206
awa 13.4 207 === Signierungsdetails ===
gru 1.1 208
awa 13.4 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
gru 1.1 212 : Passwort des Zertifikats.
awa 13.4 213 ; Behörde
gru 1.1 214 : Optionaler Name der Person oder Behörde, die das Dokument unterzeichnet.
awa 13.4 215 ; Kontakt
gru 1.1 216 : Optionale Informationen des Unterzeichners, mit denen ein Empfänger den Unterzeichner kontaktieren kann, um die Signatur zu überprüfen.
awa 13.4 217 ; Grund
gru 1.1 218 : Optionaler Grund für die Unterzeichung, z.B. //ich bin damit einverstanden//.
awa 13.4 219 ; Ort
gru 1.1 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
awa 13.4 226 ; Externen Zeitstempelserver verwenden
gru 1.1 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
awa 13.4 231 ; Zeitstempel-Server (Antwort muss der RFC3161 entsprechen)
gru 1.1 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.
awa 13.4 233 ; Zeitstempelserver Benutzername
gru 1.1 234 : Optionaler Parameter, mit dem ein Benutzername angegeben werden kann, welcher für den Zugriff auf den oben konfigurierten Zeitserver benötigt wird.
awa 13.4 235 ; Zeitstempelserver Passwort
gru 1.1 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
awa 13.4 244 ; Einen virtuellen Stempel auf das Dokument setzen
gru 1.1 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
awa 13.4 249 ; Bilddatei
gru 1.1 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.
awa 13.4 251 ; Position von links (in Pixel)
gru 1.1 252 : Horizontal Position des Stemples im signierten PDF in Pixel augehend vom linken Blattrand.
awa 13.4 253 ; Position von unten (in Pixel)
gru 1.1 254 : Vertikale Position des Stemples im signierten PDF in Pixel augehend vom unteren Blattrand.
awa 13.4 255 ; Breite des Stemples (in Pixel)
gru 1.1 256 : Breite des Stemples im signierten PDF in Pixel.
awa 13.4 257 ; Höhe des Stemples (in Pixel)
gru 1.1 258 : Höhe des Stemples im signierten PDF in Pixel.
259
260 === Ablage der erzeugten Dateien ===
261
awa 13.11 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.
awa 13.4 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.