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||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.WebHome]].
23
24 {{figure image="1_Pluginparameter.png"}}Eine Liste der Pluginparameter in der Oberfläche.{{/figure}}
25 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.
26
27 ; enable.producer.set.applicationname
28 : Legt fest, ob die Metadaten "producer" und "creator" in erzeugten PDFs mit dem Namen der Anwendung gefüllt werden sollen. Standardwert: **true**
29 ; enable.producer.action.properties
30 : Legt fest, ob die Metadaten "producer" und "creator" innerhalb der jeweiligen Aktionen einzeln konfiguriert werden können. Standardwert: **false**
31 ; pdf.sign.cert.pwd
32 : Mit diesem Parameter kann ein globales Passworet gesetzt werden, welches als Standardpasswort für alle Aktionen zum Signieren von PDFs verwendet wird.
33 ; pdf.sign.timestampserver.use
34 : Legt fest, ob ein globaler Zeitserver für alle Aktionen zum Signieren von PDFs verwendet werden soll. Standardwert: **false**
35 ; pdf.sign.timestampserver.url
36 : 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}}**
37 ; pdf.sign.timestampserver.usr
38 : Optionaler Parameter, mit dem ein Benutzername angegeben werden kann, welcher für den Zugriff auf den oben konfigurierten globalen Zeitserver benötigt wird.
39 ; pdf.sign.timestampserver.pwd
40 : Optionaler Parameter, mit dem ein Passwort angegeben werden kann, welches für den Zugriff auf den oben konfigurierten globalen Zeitserver benötigt wird.
41
42 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.
43
44 == PDF-Verschlüsselung prüfen ==
45
46 Hier handelt es sich um eine neuen 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 verschiedene weitere Aktionen ausgeführt werden.
47
48 {{figure width="600" image="5_Optionen_Check_PDF_Encryption.png"}}
49 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.
50 {{/figure}}
51
52 == PDF verschlüsseln ==
53
54 {{figure width="600" image="6_Optionen_Encrypt_PDF.png"}}
55 Hier wird PDF-Dokument //Selbstauskunft.pdf// verschlüsselt und dem Antragssteller per Download zugestellt.
56 {{/figure}}
57
58 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.
59
60 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 ist es auch möglich, 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.
61
62 Falls das PDF-Dokument bereits verschlüsselt ist, wird keine erneute Verschlüsselung durchgeführt.
63
64 === PDF-Dateien
65
66 ; Passwort zum Verschlüsseln
67 : Hier wird das Passwort eingegeben, welches für die Verschlüsselung verwendet wird. Um das so erzeugte PDF-Dokument
68 ; Dateien
69 : 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.
70
71 === Ablage der erzeugten Dateien ===
72
73 ; Ausgabedateiname
74 : 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.
75 ; An den Vorgang anhängen
76 : 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.
77
78 == PDFs vereinigen ==
79
80 {{figure image="2_Optionen_Merge_PDF.png"}}
81 Optionen mit denen eine Aktion vom Typ //PDF-Utils:Merge PDF// in der Statusverarbeitung konfiguriert werden kann.
82 {{/figure}}
83
84 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:
85
86 === Allgemeine Einstellungen ===
87
88 ; PDFs
89 : Hier können die PDFs ausgewählt werden, welche im Ausgabedokument zusammengeführt werden. Zudem kann die die Reihenfolge bestimmt werden.
90 : \\
91 : 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.
92 : \\
93 : 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.
94 ; Name der Ausgabedatei
95 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
96
97 === Metadaten ===
98
99 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.
100
101 ; Titel
102 : Inhalt des Metadatenfeldes //title// im erzeugten PDF.
103 ; Betreff
104 : Inhalt des Metadatenfeldes //subject// im erzeugten PDF.
105 ; Schlagwörter
106 : Inhalt des Metadatenfeldes //keywords// im erzeugten PDF.
107 ; Autor
108 : Inhalt des Metadatenfeldes //author// im erzeugten PDF.
109
110 Die beiden folgenden Optionen sind nur dann verfügbar, wenn der Pluginparameter **enable.producer.action.properties** auf **true** gesetzt wurde.
111
112 ; Inhalt erstellt mit
113 : 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.
114 ; Codierungs-Software
115 : 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.
116
117 === Ablage der erzeugten Dateien ===
118
119 ; An den Vorgang anhängen
120 : 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.
121
122 == PDF-A-Konvertierung ==
123
124 {{figure image="3_Optionen_PDF_to_PDF_A.png"}}Optionen mit denen eine Aktion vom Typ //PDF-Utils:PDF to PDF/A// in der Statusverarbeitung konfiguriert werden kann.{{/figure}}
125 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:
126
127 === PDF/A Einstellungen ===
128
129 ; PDF
130 : 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.
131 ; Format
132 : 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.
133 ; Name der Ausgabedatei
134 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
135
136 === Metadaten ===
137
138 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.
139
140 ; Titel
141 : Inhalt des Metadatenfeldes //title// im erzeugten PDF.
142 ; Betreff
143 : Inhalt des Metadatenfeldes //subject// im erzeugten PDF.
144 ; Schlagwörter
145 : Inhalt des Metadatenfeldes //keywords// im erzeugten PDF.
146 ; Autor
147 : Inhalt des Metadatenfeldes //author// im erzeugten PDF.
148
149 Die beiden folgenden Optionen sind nur dann verfügbar, wenn der Pluginparameter **enable.producer.action.properties** auf **true** gesetzt wurde.
150
151 ; Inhalt erstellt mit
152 : 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.
153 ; Codierungs-Software
154 : 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.
155
156 === Ablage der erzeugten Dateien ===
157
158 ; An den Vorgang anhängen
159 : 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.
160
161 == PDF signieren ==
162
163 {{figure image="4_Optionen_Sign_PDF.png"}}Optionen mit denen eine Aktion vom Typ //PDF-Utils:Sign PDF// in der Statusverarbeitung konfiguriert werden kann.{{/figure}}
164 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:
165
166 === Zu Signierendes Dokument ===
167
168 ; PDF
169 : Auswahl des PDF-Dokuments, welches signiert werden soll.
170 ; Name der Ausgabedatei
171 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
172
173 === Signierungsdetails ===
174
175 ; Elektronische Signatur (Zertifikat .p12 oder .pfx)
176 : 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.
177 ; Passwort
178 : Passwort des Zertifikats.
179 ; Behörde
180 : Optionaler Name der Person oder Behörde, die das Dokument unterzeichnet.
181 ; Kontakt
182 : Optionale Informationen des Unterzeichners, mit denen ein Empfänger den Unterzeichner kontaktieren kann, um die Signatur zu überprüfen.
183 ; Grund
184 : Optionaler Grund für die Unterzeichung, z.B. //ich bin damit einverstanden//.
185 ; Ort
186 : Optionale Angabe des Hostnamen oder des physichen Ortes der Unterzeichnung, z.B. //pro.form.cloud//.
187
188 === Zeitstempelserver ===
189
190 Hier kann ein Zeitstempelserver konfiguriert werden, der die Zeit für Signieren des PDFs bereitstellt. Zunächst ist nur die folgende Option sichtbar:
191
192 ; Externen Zeitstempelserver verwenden
193 : Legt fest, ob ein externer Zeitstempelserver für die Signierung des PDF-Dokuments verwendet werden soll.
194
195 Wenn die Option //Externen Zeitstempelserver verwenden// aktiviert wurde, werden die folgenden Eingabefelder sichtbar:
196
197 ; Zeitstempel-Server (Antwort muss der RFC3161 entsprechen)
198 : 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.
199 ; Zeitstempelserver Benutzername
200 : Optionaler Parameter, mit dem ein Benutzername angegeben werden kann, welcher für den Zugriff auf den oben konfigurierten Zeitserver benötigt wird.
201 ; Zeitstempelserver Passwort
202 : Optionaler Parameter, mit dem ein Passwort angegeben werden kann, welches für den Zugriff auf den oben konfigurierten Zeitserver benötigt wird.
203
204 === Stempel ===
205
206 Ü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.
207
208 Zunächst ist nur die folgende Option sichtbar:
209
210 ; Einen virtuellen Stempel auf das Dokument setzen
211 : Legt fest, ob ein virtuellen Stempel in das signierte PDF-Dokument eingefügt werden soll.
212
213 Wenn die Option //Einen virtuellen Stempel auf das Dokument setzen// aktiviert wurde, werden die folgenden Eingabefelder sichtbar:
214
215 ; Bilddatei
216 : 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.
217 ; Position von links (in Pixel)
218 : Horizontal Position des Stemples im signierten PDF in Pixel augehend vom linken Blattrand.
219 ; Position von unten (in Pixel)
220 : Vertikale Position des Stemples im signierten PDF in Pixel augehend vom unteren Blattrand.
221 ; Breite des Stemples (in Pixel)
222 : Breite des Stemples im signierten PDF in Pixel.
223 ; Höhe des Stemples (in Pixel)
224 : Höhe des Stemples im signierten PDF in Pixel.
225
226 === Ablage der erzeugten Dateien ===
227
228 ; An den Vorgang anhängen
229 : 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.