Benutzerdefinierte Dokumentmerkmale definieren

Sie verwenden angepasste Dokumentmerkmale, um Daten aus jedem Dokument eines Jobs zu extrahieren. Zunächst definieren Sie die angepassten Dokumentmerkmale in RICOH ProcessDirector und ordnen dann Daten in den Dokumenten den Dokumentmerkmalen zu. Wenn der Job den Workflow durchläuft, extrahiert der Schritt IdentifyPDFDocuments (PDF-Dateien) oder IdentifyDocuments (AFP-Dateien) die Daten.

Identifizieren Sie Daten, die Sie aus Dokumenten extrahieren möchten. Wenn RICOH ProcessDirector ein geeignetes Dokumentmerkmal liefert, verwenden Sie dieses, anstatt ein angepasstes Dokumentmerkmal zu definieren.

Sie möchten beispielsweise Kontonummer, Kundenname, E-Mail-Adresse und Datum der Erklärung aus jedem Dokument in einem Job extrahieren. RICOH ProcessDirector liefert ein Dokumentmerkmal, E-Mail-Adresse, zum Extrahieren von E-Mail-Adressen. Sie definieren angepasste Dokumentmerkmale für Kontonummer, Kundenname und Datum der Erklärung.

    Hinweis:
  • Wenn Sie ab Version 3.11.2 benutzerdefinierte Dokumenteigenschaften verwenden, können Sie diese auf der Registerkarte Verwaltung unter Objekte ⇒ Benutzerdefinierte Eigenschaften erstellen.

    Sie können den Datenbanknamen und die Bezeichnung, die in Eigenschaftsnotizbüchern und Spaltenüberschriften angezeigt wird, auswählen. Sie können auch auswählen, welche Art von Daten in der Eigenschaft gespeichert wird, sowie den Standardzugriff, den die verschiedenen Benutzergruppen auf die Eigenschaft haben, ohne dass Sie sie zur Datei docCustomDefinitions.xml hinzufügen müssen.

    Weitere Informationen finden Sie unter den Themen Benutzerdefinierte Job- und Dokumenteigenschaften und Erstellen und Aktivieren von benutzerdefinierten Eigenschaften.

  • Wenn Sie bereits benutzerdefinierte Dokumenteigenschaften in einer docCustomDefinitions.xml-Datei definiert haben, können Sie diese weiterhin verwenden. Erstellen Sie sie nicht über die Registerkarte Verwaltung neu. Verwenden Sie diese Registerkarte nur zum Erstellen neuer Job- oder Dokumenteigenschaften.
  • Wenn Sie die neue Funktion verwenden möchten, die in Version 3.11.2 in RICOH ProcessDirector verfügbar ist, um eine benutzerdefinierte Eigenschaft zu erstellen:
So definieren Sie angepasste Dokumentmerkmale:
  1. Wählen Sie den Typ des angepassten Dokumentmerkmals aus:
    • Datenbankmerkmal
    • Eingeschränktes Merkmal

    Weitere Informationen zur Datei docCustomDefinitions.xml finden Sie unter Datei docCustomDefinitions.xml.

  2. Wählen Sie einen (internen) Datenbanknamen für das angepasste Datenbankmerkmal.

    Definieren Sie beispielsweise ein angepasstes Dokumentmerkmal mit dem Datenbanknamen Doc.Custom.AccountNumber.

      Hinweis:

    • Wir empfehlen, dass die Datenbanknamen Ihrer eigenen Dokumentmerkmale mit Doc.Custom beginnen. Falls Sie diese Namenskonvention nicht verwenden, dann vergewissern Sie sich, dass keins Ihrer angepassten Dokumentmerkmale denselben Datenbanknamen wie ein Dokumentmerkmal hat, das mit RICOH ProcessDirector geliefert wird.

    • Verwenden Sie im Datenbanknamen keine Zahl direkt nach dem Punkt (.) Beispiel: Der Datenbankname Doc.3rdLineAddress ist nicht gültig.

    • Löschen Sie keine angepassten Dokumentmerkmale, nachdem Sie sie zur Datei docCustomDefinitions.xml hinzugefügt haben.

    • Ändern Sie nicht den name (Datenbankname), dataType oder dbType eines angepassten Dokumentmerkmals. Das System erlaubt die Änderung von caption (Name der Benutzeroberfläche), shortCaption, description und access.

  3. Wählen Sie einen Benutzeroberflächennamen (caption) für das angepasste Datenbankmerkmal.

    Definieren Sie beispielsweise ein angepasstes Dokumentmerkmal mit dem Benutzeroberflächennamen Kontonummer.

      Hinweis:
    • Wir empfehlen, dass Sie ein angepasstes Dokumentmerkmal nicht mit demselben Benutzerschnittstellennamen definieren, den bereits ein Dokumentmerkmal hat, das von RICOH ProcessDirector bereitgestellt wird.
  4. Wählen Sie einen Datentyp (dataType) für das angepasste Datenbankmerkmal.

    Beispiele sind String, Integer, IntegerNonNeg und Timestamp.

  5. Für Datenbankmerkmale:
    1. Wählen Sie einen Datenbanktyp (dbType) aus.

      Für den Datentyp String sind die Datenbanktypen char, varchar undlong varchar.

      Für den Datentyp Integer sind die Datenbanktypen smallint, bigint und integer.

      Für den Datentyp Timestamp ist der Datenbanktyp Timestamp.

    2. Wählen Sie die Zugriffsebene, die Benutzer für das angepasste Dokumentmerkmal haben:

      • attrWriteAdmin

        Mitglieder der Administrator-Sicherheitsgruppe haben Schreibzugriff. Mitglieder der Sicherheitsgruppen Überwachung, Bediener und Supervisor haben Lesezugriff.

      • attrWriteAdminSuper

        Supervisoren und Administratoren haben Schreibzugriff. Überwachung und Bediener haben Lesezugriff.

      • attrWriteAdminSuperOper

        Bediener, Supervisoren und Administratoren haben Schreibzugriff. Überwachung hat Lesezugriff.

      Wenn Sie keine Zugriffsebene festlegen, haben Administratoren Schreibzugriff. Überwachung, Bediener und Supervisoren haben Lesezugriff.

        Hinweis:
      • Wenn Sie Ihre eigenen Sicherheitsgruppen erstellt haben, erhalten diese denselben Zugriff auf angepasste Dokumentmerkmale wie die RICOH ProcessDirector-Sicherheitsgruppen, die Sie zum Erstellen Ihrer Gruppen kopiert haben.

    3. Wählen Sie eine Kurzbeschriftung.

      Die Kurzbeschriftung wird in den Spaltenüberschriften der Tabelle angezeigt.

      Definieren Sie beispielsweise ein angepasstes Dokumentmerkmal mit der Kurzbeschriftung Kontonr.

    4. Wählen Sie eine Beschreibung.

      Die Benutzeroberfläche zeigt die Beschreibung als Hilfe für das angepasste Dokumentmerkmal an.

      Definieren Sie beispielsweise ein angepasstes Dokumentmerkmal mit der Beschreibung Kontonummer des Kunden.

  6. Bearbeiten Sie die Dokumentmerkmalkonfigurationsdatei:
    • Wenn Sie ein angepasstes Dokumentmerkmal zum ersten Mal definieren, erstellen Sie eine Kopie der mitgelieferten Beispieldatei. Gehen Sie in folgendes Verzeichnis:

      • /aiw/aiw1/samples/config unter Linux

      • C:\aiw\aiw1\samples\config unter Windows

    • Wenn Sie weitere Dokumentmerkmale definieren, erstellen Sie eine Kopie der aktiven Datei. Gehen Sie in folgendes Verzeichnis:

      • /aiw/aiw1/config unter Linux

      • C:\aiw\aiw1\config unter Windows

  7. Kopieren Sie die Datei docCustomDefinitions.xml in ein Arbeitsverzeichnis und bearbeiten Sie die Datei.

    Bewahren Sie eine Sicherungskopie der bearbeiteten Datei zu Wiederherstellungszwecken auf.

    Diese Zeilen fügen beispielsweise zwei Datenbankdokumentmerkmale mit dem Datenbanknamen Doc.Custom.AccountNumber und Doc.Custom.StatementDate zu folgender Datei hinzu: 

    <docProperty name="Doc.Custom.AccountNumber"
   datatype="String"
   dbType="varchar (32)"
   access="attrWriteAdmin"
   shortCaption="Acount number"
   caption="Account number"
   description="Customer account number"/>

<docProperty name="Doc.Custom.StatementDate"
   datatype="Timestamp"
   dbType="Timestamp"
   access="attrWriteAdmin"
   shortCaption="Statement date"
   caption="Statement date"
   description="The date the statement was created"/>
      Hinweis:
    • Die Zeile name legt den Datenbanknamen fest. Die Zeile caption legt den Benutzerschnittstellennamen fest.

    Diese Zeilen fügen zwei eingeschränkte Dokumentmerkmale mit den internen Namen Doc.Custom.SSNumber und Doc.Custom.CheckAmt zu folgender Datei hinzu:

    <limitedProperties>

   <docProperty name="Doc.Custom.SSNumber"
      datatype="String"
      caption="Social Security number"/>

   <docProperty name="Doc.Custom.CheckAmt"
      datatype="String"
      caption="Check total"/>

</limitedProperties>
  8. Verwenden Sie einen XML-Editor zum Überprüfen der Syntax.
  9. Kopieren Sie die bearbeitete Datei in folgendes Verzeichnis:
    • /aiw/aiw1/config/docCustomDefinitions.xml (Linux)
    • C:\aiw\aiw1\config\docCustomDefinitions.xml (Windows)
  10. Um neue Dokumentmerkmale auf der Benutzeroberfläche ordnungsgemäß anzeigen zu lassen, bearbeiten Sie die Datei docCustomDefinitions.properties für eine oder mehrere Sprachen. Wenn Sie in dieser Datei keine Bezeichnungen für die neuen Merkmale definieren, sehen Sie nur Datenbanknamen für die Merkmale auf der Benutzeroberfläche. Weitere Informationen finden Sie unter Angepasste Dokumentmerkmale in mehr als einer Sprache benennen für die Schritte zum Bearbeiten der Datei.
  11. Stellen Sie RICOH ProcessDirector die definierten angepassten Dokumentmerkmale zur Verfügung:
    1. Führen Sie das Dienstprogramm docCustom aus.
      Wenn Sie das Dienstprogramm docCustom das erste Mal ausführen, erstellt es das Feature Custom Document Properties und fügt es dem Feature Manager hinzu. Wenn Sie das Dienstprogramm erneut ausführen, wird ein aktualisiertes Feature Custom Document Properties zum Feature Manager hinzugefügt.
    2. Verwenden Sie den Feature Manager, um das Feature Custom Document Properties zu installieren oder zu aktualisieren.
  12. Laden Sie die aktualisierten RICOH ProcessDirector-Dokumentmerkmale in das Tool, das Sie zum Konfigurieren von Dokumentmerkmalen verwenden:
    • Wenn Sie über das PDF-Dokument-Unterstützung-Feature verfügen, dann laden Sie RICOH ProcessDirector-Dokumentmerkmale in RICOH ProcessDirector-Plugin für Adobe Acrobat.

      Weitere Informationen finden Sie im entsprechenden Thema im Information Center.

    • Wenn Sie über das AFP-Unterstützung-Feature verfügen, verwenden Sie eine der folgenden Methoden, um RICOH Visual Workbench zu starten:

      • Starten Sie RICOH Visual Workbench über denRICOH ProcessDirector-Server.

      • Ersetzen Sie die RICOH Visual Workbench-Anwendung auf Ihrem Desktop:

        • Löschen Sie die Datei VisualWorkbench.zip und alle nicht extrahierten Dateien.

        • Laden Sie die Datei VisualWorkbench.zip von der RICOH ProcessDirector-Benutzeroberfläche herunter.

        • Entpacken Sie die Datei und starten Sie die neue RICOH Visual Workbench-Desktopanwendung.

      Die Dokumentmerkmale werden automatisch geladen.

Related information:

Datei docCustomDefinitions.xml
Hinweise bei Systemen mit mehreren Sprachen
Angepasste Dokumentmerkmale aktualisieren
Angepasste Dokumentmerkmale in mehr als einer Sprache benennen
Einrichten zum manuellen Abgleichen von Jobs
Übergeordnetes Thema: Feature auf dem RICOH ProcessDirector primären Computer installieren