DocuWare Control

Frage:
Was ist DocuWare Control und wie kann es eingesetzt werden?

Lösungen:
Mit DocuWare Control können Sie die Bearbeitung Ihrer Dokumente über spezielle Befehle steuern. Bitte beachten Sie die Anleitung zur Konfiguration von DocuWare Control;

DocuWare Control mit DocuWare Drucker
Jede DocuWare Control-Anweisung muss mit <dwControl: beginnen.

• Achten Sie darauf, dass alle Befehle mit der Schriftart "DWControl.ttf" geschrieben sind, damit sie als gültige Befehle erkannt werden.
  Die Schriftart DWControl.ttf wird mit DocuWare Printer installiert. Alternativ kann sie auch in "...\DocuWare\Desktop\Printer\DWControl.ttf" gefunden werden.
• Es spielt keine Rolle, welche Farbe oder Größe die Befehle haben, Sie können z.B. weiße Befehle auf weißem Hintergrund verwenden.
• Alle Befehle werden nach ihrer Verarbeitung aus dem Dokument entfernt.

• DWControl-Befehl für DW Printer:

• DWControl-Befehl für DW Import:

• Alle Befehle müssen in einer .dwcontrol-Datei angegeben werden, und zwar in einem < Page>-Abschnitt
• Achten Sie auf die Groß- und Kleinschreibung.
• Jede .dwcontrol-Datei muss mit der folgenden Zeile beginnen

• Für weitere Informationen und Beispiele siehe KBA-36502.

DocuWare Control Befehle:
Die vollständige Liste der DocuWare Control-Befehle finden Sie im Knowledge Center-DocuWare Control. Weitere Beispiele und wichtige Informationen finden Sie in den folgenden Informationen: SelectConfiguration
Wenn Sie mit DocuWare-Druckerkonfigurationen vertraut sind, können Sie eine Konfiguration einfach über ihren Namen auswählen. Das Dokument wird dann so verarbeitet, als ob die Konfiguration automatisch erkannt worden wäre.
<dwControl:SelectConfiguration name="Letter"/>
Hinweis: Der Befehl SelectConfiguration kann nicht in Kombination mit anderen Befehlen verwendet werden. Wenn andere Befehle im Dokument gefunden werden, werden sie ignoriert.

NewDocument
Wenn dieser Befehl auf einer Seite des Dokuments gefunden wird, wird sie zur ersten Seite eines neuen Dokuments.
<dwControl:NewDocument />

FileCabinet
In diesem Beispiel soll das Dokument in einem File Cabinet mit der Bezeichnung "Rechnungen und Bestellungen" abgelegt werden.
<dwControl:FileCabinet name="Invoices & Orders"/>

 Sie können stattdessen auch die GUID des Cabinets verwenden..
<dwControl:FileCabinet id="12345678-1234-1234-1234-123456789abc"/>

Basket oder DocumentTray
Um das Dokument in einem Briefkorb zu speichern, verwenden Sie den Befehl Basket oder DocumentTray.
<dwControl:Basket name="Basket-Sanders"/>
<dwControl:DocumentTray name=" Basket-Sanders "/>

Felder
Der Befehl Field dient dazu, ein Metadaten- oder Indexfeld des zu speichernden Dokuments zu füllen. Das Feld wird durch seinen Datenbankspaltennamen identifiziert. Derzeit werden vier Arten von Feldern unterstützt, die in den folgenden Abschnitten beschrieben werden. Die Attribute dbName und type sind erforderlich.

• Text/Memo-Werte
  <dwControl:Field dbName="EMPLOYEE" type="Text" value="Mark Smith"/>
  <dwControl:Field dbName="MEMO" type="Memo" value="Text"/>
• Schlüsselwort-Werte
  <dwControl:Field dbName="Bemerkung" type="Keyword" value="eins"/>
  <dwControl:Field dbName="Bemerkung" type="Keyword" value="zwei"/>

Hinweis: Wenn mehrere Werte in einem einzigen Schlüsselwortfeld gespeichert werden, sind mehrere Control-Befehle erforderlich.

• Numerische Werte

In verschiedenen Kulturen werden Doppelpunkte oder Punkte und andere Zeichen unterschiedlich interpretiert, daher muss die Kultur angegeben werden, um den Wert korrekt zu interpretieren. Zum Beispiel wird 3.000 in Deutschland als 3000 interpretiert, in England jedoch als 3. In dem angegebenen Beispiel würde der Wert als 31,20 gespeichert werden.
<dwControl:Field dbName="SALARY" type="Numeric" value="31,2" culture="de-CH" decimalPlaces="2" />
Beim Speichern eines Dokuments in einem Warenkorb müssen wir aufgrund einer archaischen DocuWare-Beschränkung die Anzahl der Dezimalstellen des Wertes kennen, der im Warenkorb gespeichert werden soll. Im gegebenen Beispiel würde der Wert automatisch als 3120 im Korb gespeichert werden, wenn decimalPlaces 2 ist. Das manuelle Ablegen des Dokuments vom Korb in das Filecabinet würde dann wieder 31,20 ergeben. Wenn decimalValues nicht angegeben wird, ist der Standardwert 2.

• Datumswerte

<dwControl:Field dbName="EMPLOYMENTDATE" type="Date" value="2010-04-03" culture="en-US" format="yyyy-MM-dd" />
<dwControl:Field dbName="EMPLOYMENTDATE" type="Date" value="03 April 2010" culture="en-US" format="dd MMMM yyyy" />
<dwControl:Field dbName="DATUM" type="Date" value="03.04.2010" culture="de-DE" format="dd.MM.yyyy" />
<dwControl:Field dbName="DATUMZEIT" type="DateTime" value="2010-04-03 7:43p" culture="en-US" format="yyyy-MM-dd h:mmt" />

Formular
Wenn Sie Dokumente ohne Briefköpfe erstellen, können Sie diese mit dem Befehl Formular hinzufügen. Er bezieht sich nur auf die Seite, auf der er sich befindet. Befinden sich mehrere Form-Befehle auf einer Seite, wird der erste verwendet.
Als Formular oder Briefkopf müssen Sie eine PDF-Datei verwenden. Diese Datei kann sich auf einer lokalen Ressource befinden, die durch den Parameter path definiert wird, oder sie kann Teil einer Druckerkonfiguration sein.
 
Beispiel für die Verwendung einer lokalen Ressource.
<dwControl:Form path="C:\forms\letterhead.pdf" />

Verwendung einer Druckerkonfiguration als Formularspeicher
In jeder Druckerkonfiguration können Sie Formulare für die erste oder alle anderen Seiten festlegen. Die Parameter configName und configId verweisen auf eine solche Konfiguration. Der Parameter configForm kann den Wert 1 für die erste Seite oder 2 für alle anderen Seiten haben, um eines der Formulare in der referenzierten Konfiguration auszuwählen. Für diese Konfiguration sind Nutzungsrechte erforderlich.
 
Wenn Sie zum Beispiel eine Konfiguration "Briefe" haben, in der ein Briefkopf für die erste Seite definiert ist, können Sie diesen mit diesem Befehl verwenden.
<dwControl:Form configName="Briefe" configForm="1"/>

Drucken
Wenn Sie das Dokument an einen anderen Drucker weiterleiten möchten, können Sie den Befehl Drucken verwenden. Der Name des Druckers kann im Geräteattribut angegeben werden. Es werden die Standardeinstellungen dieses Druckers verwendet. Wenn Sie eine bestimmte Einstellung benötigen, legen Sie eine zusätzliche Instanz des Druckers mit einem anderen Namen an und definieren dort die gewünschte Einstellung.
Falls Sie den Befehl Formular verwenden, können Sie außerdem wählen, ob der Ausdruck mit oder ohne Formular erfolgen soll. Im Wert von withoutForm können Sie true eintragen, wenn Sie das definierte Formular nicht ausdrucken wollen, ansonsten false.
<dwControl:Print device="mein Drucker" withoutForm="true" />
Wenn nicht definiert, wird withoutForm auf false gesetzt.

Drucken auf dem Standarddrucker:
<dwControl:Print />

Sie haben die Möglichkeit, zusätzliche Dokumente, wie z.B. AGBs am Ende des Dokuments zu drucken. Die Datei muss im pdf-Format vorliegen.
<dwControl:Print device="mein Drucker" additionalFilePath="C:\terms\conditions.pdf" />
 
Verwendung einer Druckerkonfiguration als zusätzliche Dateiablage
Ähnlich wie beim Befehl Form können Sie Druckerkonfigurationen verwenden, um benötigte Dateien an den Ausführer von DocuWare Control-Befehlen zu übergeben.
 
Der additionalFileConfigName referenziert die Druckerkonfigurationen, in denen eine zusätzliche Druckdatei definiert werden muss. Für diese Konfiguration werden Nutzungsrechte benötigt:
<dwControl:Print device="mein Rechnungsdrucker" additionalFileConfigName="Invoices" />

Unterschreiben
Wenn Sie das Dokument elektronisch signieren möchten, können Sie den Befehl Signieren verwenden. Ähnlich wie beim Befehl Form können Sie Druckerkonfigurationen verwenden, um die benötigten Informationen zu laden, in diesem Fall ein Zertifikat.
Der certificateConfigName verweist auf die Druckerkonfigurationen, in denen eine Signatur konfiguriert werden muss. Für diese Konfiguration werden Nutzungsrechte benötigt.
<dwControl:Sign certificateConfigName="Sign pdf" />
 
Sonderzeichen
Ein Wert muss entweder mit einfachen Anführungszeichen 'example' oder mit doppelten Anführungszeichen "example" umgeben werden.
Bei der Verwendung von DWControl mit DW Printer müssen Sonderzeichen nicht escaped werden, bei der Verwendung von DWControl mit DW Import müssen Sonderzeichen jedoch korrekt escaped werden.
 
Bitte lesen Sie die folgenden KBAs für Informationen über DocuWare Control mit Sonderzeichen:

• Wie verwendet man Sonderzeichen in den .dwcontrol-Metadaten? - KBA-35321
• Wie werden Umlaute in eine DWControl-Datei eingebettet?- KBA-35278

Unzulässige Zeichenfolgen in Parameterwerten
Bitte vermeiden Sie die Verwendung dieser Zeichenfolgen in Ihren DocuWare Control Parametern:
Verwenden Sie nicht die DW Control Zeichenketten "<dwControl:...":
<dwControl:Field dbName="REMARK" type="Text" value=" <dwControl:NewDocument/> "/>
 
Innerhalb von einfachen Anführungszeichen ist jedes einzelne Anführungszeichen verboten.
<dwControl:Field dbName="REMARK" type="Text" value=' Sag:'Hello '/>
 
Innerhalb von doppelten Anführungszeichen sind alle doppelten Anführungszeichen verboten.
<dwControl:Field dbName="REMARK" type="Text" value=" Sag: "Hallo" "/>

KBA ist für Cloud- und On-Premise-Organisationen anwendbar.