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üsseln ==
45
46 == PDF-Verschlüsselung prüfen ==
47
48 == PDFs vereinigen ==
49
50 {{figure image="2_Optionen_Merge_PDF.png"}}Optionen mit denen eine Aktion vom Typ //PDF-Utils:Merge PDF// in der Statusverarbeitung konfiguriert werden kann.{{/figure}}
51 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:
52
53 === Allgemeine Einstellungen ===
54
55 ; **PDFs**
56 : Hier können die PDFs ausgewählt werden, welche im Ausgabedokument zusammengeführt werden. Zudem kann die die Reihenfolge bestimmt werden.
57 : \\
58 : 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.
59 : \\
60 : 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.
61 ; **Name der Ausgabedatei**
62 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
63
64 === Metadaten ===
65
66 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.
67
68 ; **Titel**
69 : Inhalt des Metadatenfeldes //title// im erzeugten PDF.
70 ; **Betreff**
71 : Inhalt des Metadatenfeldes //subject// im erzeugten PDF.
72 ; **Schlagwörter**
73 : Inhalt des Metadatenfeldes //keywords// im erzeugten PDF.
74 ; **Autor**
75 : Inhalt des Metadatenfeldes //author// im erzeugten PDF.
76
77 Die beiden folgenden Optionen sind nur dann verfügbar, wenn der Pluginparameter **enable.producer.action.properties** auf **true** gesetzt wurde.
78
79 ; **Inhalt erstellt mit**
80 : 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.
81 ; **Codierungs-Software**
82 : 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.
83
84 === Ablage der erzeugten Dateien ===
85
86 ; **An den Vorgang anhängen**
87 : Die in dieser Aktion erzeugte Datei ist standardmäßig nur während der Status- und Aktionsverarbeitung verfügbar. Wenn diese Option aktiviert wird, kann die durch die Aktion erzeugte Datei an den Vorgang angehangen werden.
88
89 == PDF-A-Konvertierung ==
90
91 {{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}}
92 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:
93
94 === PDF/A Einstellungen ===
95
96 ; **PDF**
97 : 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.
98 ; **Format**
99 : 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.
100 ; **Name der Ausgabedatei**
101 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
102
103 === Metadaten ===
104
105 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.
106
107 ; **Titel**
108 : Inhalt des Metadatenfeldes //title// im erzeugten PDF.
109 ; **Betreff**
110 : Inhalt des Metadatenfeldes //subject// im erzeugten PDF.
111 ; **Schlagwörter**
112 : Inhalt des Metadatenfeldes //keywords// im erzeugten PDF.
113 ; **Autor**
114 : Inhalt des Metadatenfeldes //author// im erzeugten PDF.
115
116 Die beiden folgenden Optionen sind nur dann verfügbar, wenn der Pluginparameter **enable.producer.action.properties** auf **true** gesetzt wurde.
117
118 ; **Inhalt erstellt mit**
119 : 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.
120 ; **Codierungs-Software**
121 : 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.
122
123 === Ablage der erzeugten Dateien ===
124
125 ; **An den Vorgang anhängen**
126 : Die in dieser Aktion erzeugte Datei ist standardmäßig nur während der Status- und Aktionsverarbeitung verfügbar. Wenn diese Option aktiviert wird, kann die durch die Aktion erzeugte Datei an den Vorgang angehangen werden.
127
128 == PDF signieren ==
129
130 {{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}}
131 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:
132
133 === Zu Signierendes Dokument ===
134
135 ; **PDF**
136 : 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// für die Verwendung bereitzustellen.
137 ; **Name der Ausgabedatei**
138 : Dateiname, unter dem das erzeugte PDF-Dokument gespeichert wird.
139
140 === Signierungs Details ===
141
142 ; **Elektronische Signatur (Zertifikat .p12 oder .pfx)**
143 : Auswahl einer Zertifikatsdatei, welche für das signieren des PDFs verwendet werden soll. Die Datei muss im [[Mandant>>doc:Formcycle.UserInterface.FilesAndTemplates.Files]] oder im [[Formular>>doc:Formcycle.UserInterface.MyForms.Files]] hinterlegt sein.
144 ; **Passwort**
145 : Passwort des Zertifikats.
146 ; **Behörde**
147 : Optionaler Name der Person oder Behörde, die das Dokument unterzeichnet.
148 ; **Kontakt**
149 : Optionale Informationen des Unterzeichners, mit denen ein Empfänger den Unterzeichner kontaktieren kann, um die Signatur zu überprüfen.
150 ; **Grund**
151 : Optionaler Grund für die Unterzeichung, z.B. //ich bin damit einverstanden//.
152 ; **Ort**
153 : Optionale Angabe des Hostnamen oder des physichen Ortes der Unterzeichnung, z.B. //pro.form.cloud//.
154
155 === Zeitstempelserver ===
156
157 Hier kann ein Zeitstempelserver konfiguriert werden, der die Zeit für Signieren des PDFs bereitstellt. Zunächst ist nur die folgende Option sichtbar:
158
159 ; **Externen Zeitstempelserver verwenden**
160 : Legt fest, ob ein externer Zeitstempelserver für die Signierung des PDF-Dokuments verwendet werden soll.
161
162 Wenn die Option //Externen Zeitstempelserver verwenden// aktiviert wurde, werden die folgenden Eingabefelder sichtbar:
163
164 ; **Zeitstempel Server (Antwort muss der RFC3161)**
165 : 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.
166 ; **Zeitstempelserver Benutzername**
167 : Optionaler Parameter, mit dem ein Benutzername angegeben werden kann, welcher für den Zugriff auf den oben konfigurierten Zeitserver benötigt wird.
168 ; **Zeitstempelserver Passwort**
169 : Optionaler Parameter, mit dem ein Passwort angegeben werden kann, welches für den Zugriff auf den oben konfigurierten Zeitserver benötigt wird.
170
171 === Stempel ===
172
173 Ü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.
174
175 Zunächst ist nur die folgende Option sichtbar:
176
177 ; **Einen virtuellen Stempel auf das Dokument setzen**
178 : Legt fest, ob ein virtuellen Stempel in das signierte PDF-Dokument eingefügt werden soll.
179
180 Wenn die Option //Einen virtuellen Stempel auf das Dokument setzen// aktiviert wurde, werden die folgenden Eingabefelder sichtbar:
181
182 ; **Bilddatei**
183 : 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.
184 ; **Position von links (in Pixel)**
185 : Horizontal Position des Stemples im signierten PDF in Pixel augehend vom linken Blattrand.
186 ; **Position von unten (in Pixel)**
187 : Vertikale Position des Stemples im signierten PDF in Pixel augehend vom unteren Blattrand.
188 ; **Breite des Stemples (in Pixel)**
189 : Breite des Stemples im signierten PDF in Pixel.
190 ; **Höhe des Stemples (in Pixel)**
191 : Höhe des Stemples im signierten PDF in Pixel.
192
193 === Ablage der erzeugten Dateien ===
194
195 ; **An den Vorgang anhängen**
196 : Die in dieser Aktion erzeugte Datei ist standardmäßig nur während der Status- und Aktionsverarbeitung verfügbar. Wenn diese Option aktiviert wird, kann die durch die Aktion erzeugte Datei an den Vorgang angehangen werden.