Datei docCustomDefinitions.xml

Datenbankmerkmale und eingeschränkte Merkmale

Sie können zwei Arten von Dokumentmerkmalen definieren:

• Datenbankmerkmale
• Eingeschränkte Merkmale

Sie können beide Arten von Merkmalen in einer Dokumentmerkmaldatei speichern und bearbeiten, aber in der Datenbank werden nur Datenbankmerkmale gespeichert.

Sie können mit beiden Arten von Merkmalen wie folgt arbeiten:

• Sie können die Merkmale mit Schritten in einem Workflow verwenden, um Dokumente zu gruppieren oder zu sortieren (z. B. mit der Schrittvorlage SortDocuments).
• Sie können sie mit der RICOH Visual Workbench-Funktion Document Property Designer mit AFP-Indexkennzeichen verknüpfen.
• Sie können ihnen mit RICOH ProcessDirector-Plugin für Adobe Acrobat Dokumentdaten in PDF-Jobs zuordnen.
• Falls Sie das Archiv-Feature haben, können Sie sie in einem Repository speichern. Nach dem Speichern können Sie sie verwenden, um das Repository zu durchsuchen und Jobs, Dokumente und Verlaufsdaten abzurufen. Die Werte der Merkmale werden in der Registerkarte "Merkmale" angezeigt, wenn Sie in der Ergebnistabelle auf Details anzeigen klicken.
• Falls Sie das Einstellungsverwaltung-Feature haben, können Sie eine externe Einstellungsdatei verwenden, um die Werte der Merkmale festzulegen.

Auf diese Art können Sie mit Datenbankmerkmalen, aber nicht mit eingeschränkten Merkmalen arbeiten:

• Sie können sie verwenden, um im Portlet "Dokumente" auf der Seite Hauptseite der Benutzeroberfläche nach Dokumenten zu suchen.
• Wenn Sie im Portlet "Dokumente" ein Dokument auswählen, werden die Werte von Datenbankmerkmalen angezeigt.
• Sie können sie verwenden, um nach Dokumenten zu suchen, die in der Anzeigefunktion angezeigt werden sollen.
• Sie können ihre Werte in einem Job ermitteln, ihre Werte in einem anderen Job aktualisieren und die aktualisierten Werte im Originaljob verwenden.
• Falls Sie das Automatische Überprüfung- oder das Inserter-Feature haben, können Sie Datenbankmerkmale verwenden, um nach Dokumenten zum Abgleichen oder zum erneuten Drucken zu suchen.
• Wenn Sie die Erweiterungsfunktion Advanced Document Pool haben, können Sie Selektoren verwenden, um Dokumente anhand ihrer Merkmalwerte zu bearbeiten.

Eingeschränkte Merkmale bieten die folgenden Vorteile:

• Sie können die Merkmale verwenden, um die Anzeige von vertraulichen Merkmalwerten, z. B. Sozialversicherungsnummern oder Scheckbeträge, in der Benutzeroberfläche zu verhindern.
• Sie maximieren die Systemleistung. Die Manipulation von Datenbankmerkmalen kann die Leistung herabsetzen, wenn Sie eine große Anzahl von Dokumenten verarbeiten.

Ermitteln Sie in Zusammenarbeit mit Ihrem Kundendienst Ihre spezifischen Anforderungen in Bezug auf Datenbankmerkmale und eingeschränkte Dokumentmerkmale.

Abschnitte der Musterdatei

Die Musterdatei docCustomDefinitions.xml enthält verschiedene Abschnitte. Diese Abschnitte werden in der folgenden Tabelle zusammengefasst.

Abschnitt "Schema"

Der Abschnitt Schema enthält ein Element docCustomDefinitions und ein Element schema. Dieser Abschnitt sollte nur vom Kundendienst bearbeitet werden.

Abschnitt "Datenbankmerkmale"

Der Abschnitt Datenbankmerkmale enthält das Element docProperty.

<docProperty>

Definiert Dokumentmerkmale in der Datenbank.

Attribute für das Element "docProperty"

Attribut für docProperty	Erforderlich?	Anmerkungen
name	Ja	Der Datenbankname (interner Name) des Merkmals. Dieser Name wird von Programmen verwendet, die Merkmale lesen oder schreiben. Wir empfehlen, eine konsistente Namenskonvention für die angepassten Merkmalnamen zu verwenden, damit die Merkmalnamen im gesamten System eindeutig sind. Die Musterdatei "docCustomDefinitions.xml" benutzt beispielsweise das Präfix "Doc.Custom", damit die Merkmale in dieser Datei sich von den Merkmalen des Basisprodukts unterscheiden. Verwenden Sie im Merkmalnamen keine Sonderzeichen (wie @, #, $, % oder - (Bindestrich)) und keine Leerzeichen. Sie können Punkte und Unterstriche verwenden. Verwenden Sie im Datenbanknamen des Merkmals keine Zahl direkt nach dem Punkt (.) Beispiel: Das Merkmal Doc.3rdLineAddress ist nicht gültig.
access	Nein	Die Benutzerzugriffsebene für das Merkmal. Sie können eine bereits im Produkt definierte Zugriffsebene verwenden oder eine angepasste Zugriffsebene erstellen, wenn die vorhandenen Ihren Anforderungen nicht gerecht werden. Weitere Informationen finden Sie im Abschnitt Zugriff.
datatype	Ja	Der für das Merkmal zu benutzende Datentyp. Siehe die nächste Tabelle.
dbType	Nein	Ein Datenbankparameter, mit dem der Datentyp angegeben wird. Hinweis: Die Eigenschaft dbType wurde als veraltet angesehen und wird nicht mehr verwendet. Verwenden Sie stattdessen die Eigenschaft Datentyp.
caption	Ja	Der Benutzerschnittstellenname (Standardbeschriftung) für das Merkmal. Wenn Sie Beschriftungen in nur einer Sprache einrichten, definieren Sie sie in dieser Datei. Wenn Sie Benutzerschnittstellennamen in mehreren Sprachen einrichten, erstellen Sie zusätzliche Dokumentmerkmalnamensdateien (docCustomDefinitions_Sprache.properties) für die anderen Sprachen.
shortCaption	Ja	Die für dieses Merkmal bei Bedarf (z. B. in Spaltenüberschriften von Tabellen) angezeigte Standardkurzbeschriftung. Wenn Sie Kurzbeschriftungen in nur einer Sprache einrichten, definieren Sie sie in dieser Datei. Wenn Sie Kurzbeschriftungen in mehreren Sprachen einrichten, erstellen Sie zusätzliche Dokumentmerkmaldateien (docCustomDefinitions_Sprache.properties) für die anderen Sprachen.
Beschreibung	Ja	Die Standardbeschreibung des Dokumentmerkmals, die in der Benutzeroberfläche als Hilfetext angezeigt wird. Wenn Sie Beschreibungen in nur einer Sprache einrichten, definieren Sie sie in dieser Datei. Wenn Sie Beschreibungen in mehreren Sprachen einrichten, erstellen Sie zusätzliche Dokumentmerkmaldateien (docCustomDefinitions_Sprache.properties) für die anderen Sprachen.

Sie können die folgenden Datentypen und Datenbanktypen bei der Definition von Merkmalen zu verwenden: Beachten Sie, dass die speicherbaren Werte neben den in dieser Tabelle aufgelisteten Überprüfungsregeln auch durch die Datenbankdefinition einschränkt werden. Beispiel: Ein Typ SMALLINT kann Ganzzahlen von 0 bis 32.767 speichern. Bei Datenbanktypwerten muss die Groß-/Kleinschreibung nicht beachtet werden.

Für docProperty-Definitionen empfohlene Datentypen und Datenbanktypen

Datentyp	Datenbanktyp (in SQL benutzt)	Gültigkeitsprüfung für Datentyp
Zeichenfolge	VARCHAR(128)	VARCHAR: Variable Länge, 1 bis 128 Zeichen
IntegerNonNeg	SMALLINTBIGINTINTEGER	SMALLINT: 2 ByteBIGINT: 4 ByteINTEGER: 8 ByteMinimum=0
Zeitmarke	TIMESTAMP	TIMESTAMP: Muss Werte für Tag (D), Monat (M) und Jahr (Y) enthalten.Diese Komponenten können in einem der folgenden Formate auftreten:MM TT JJJJTT MM JJJJJJJJ MM TTTag und Monat müssen durch eine zweistellige Zahl angegeben werden.Sie können eine Tageszeit in folgendem Format hinzufügen:hh:mm:ss

XdkString10	VARCHAR(10)	VARCHAR: Variable Länge, 1 bis 10 Zeichen Hinweis: Diese Werte sind Variationen des Datentyps "String", die anstelle von Zeichenfolgen vom Typ "String" verwendet werden können, um den in der Datenbank reservierten Speicherplatz für Eigenschaftswerte zu verringern.
XdkString20	VARCHAR(20)	VARCHAR: Variable Länge, 1 bis 20 Zeichen Hinweis: Diese Werte sind Variationen des Datentyps "String", die anstelle von Zeichenfolgen vom Typ "String" verwendet werden können, um den in der Datenbank reservierten Speicherplatz für Eigenschaftswerte zu verringern.
XdkString30	VARCHAR(30)	VARCHAR: Variable Länge, 1 bis 30 Zeichen Hinweis: Diese Werte sind Variationen des Datentyps "String", die anstelle von Zeichenfolgen vom Typ "String" verwendet werden können, um den in der Datenbank reservierten Speicherplatz für Eigenschaftswerte zu verringern.
XdkString40	VARCHAR(40)	VARCHAR: Variable Länge, 1 bis 40 Zeichen Hinweis: Diese Werte sind Variationen des Datentyps "String", die anstelle von Zeichenfolgen vom Typ "String" verwendet werden können, um den in der Datenbank reservierten Speicherplatz für Eigenschaftswerte zu verringern.
XdkString50	VARCHAR(50)	VARCHAR: Variable Länge, 1 bis 50 Zeichen Hinweis: Diese Werte sind Variationen des Datentyps "String", die anstelle von Zeichenfolgen vom Typ "String" verwendet werden können, um den in der Datenbank reservierten Speicherplatz für Eigenschaftswerte zu verringern.
XdkString128	VARCHAR(128)	VARCHAR: Variable Länge, 1 bis 128 Zeichen Hinweis: Diese Werte sind Variationen des Datentyps "String", die anstelle von Zeichenfolgen vom Typ "String" verwendet werden können, um den in der Datenbank reservierten Speicherplatz für Eigenschaftswerte zu verringern.

Abschnitt "Eingeschränkte Merkmale"

Der Abschnitt Eingeschränkte Merkmale enthält ein oder mehrere docProperty-Elemente.

<docProperty>

Identifiziert Dokumentmerkmale, die nur in der Dokumentmerkmaldatei, aber nicht in der Datenbank manipuliert werden.

Attribute für das Element "docProperty"

Attribut für docProperty	Erforderlich?	Anmerkungen
name	Ja	Wir empfehlen, eine konsistente Namenskonvention für die angepassten Merkmalnamen zu verwenden, sodass die Merkmalnamen im gesamten System eindeutig sind. Die Musterdatei "docCustomDefinitions.xml" benutzt beispielsweise das Präfix "Doc.Custom", damit die Merkmale in dieser Datei sich von den Merkmalen des Basisprodukts unterscheiden. Verwenden Sie im Merkmalnamen keine Sonderzeichen (wie @, #, $, % oder - (Bindestrich)) und keine Leerzeichen. Sie können Punkte und Unterstriche verwenden. Verwenden Sie im Datenbanknamen des Merkmals keine Zahl direkt nach dem Punkt (.) Beispiel: Das Merkmal Doc.3rdLineAddress ist nicht gültig.
datatype	Nein	Siehe die nächste Tabelle.
caption	Nein	Die in der Benutzeroberfläche in Listen angezeigte Beschriftung für dieses Merkmal. Wenn Sie Beschriftungen in nur einer Sprache einrichten, definieren Sie sie in dieser Datei. Wenn Sie Beschriftungen in mehreren Sprachen einrichten, erstellen Sie eine Dokumentmerkmaldatei (docCustomDefinitions_Sprache.properties) für die anderen Sprachen. Ausführliche Informationen finden Sie im entsprechenden Thema im Information Center.

Sie können diese Datentypen in docProperty-Definitionen verwenden:

Datentypen für das Element "docProperty"

Datentyp	Gültigkeitsprüfung für Datentyp
Zeichenfolge	Nein
IntegerNonNeg	Ganze Zahl zwischen 0 und 2147483647
Zeitmarke	TIMESTAMP: Muss Werte für Tag (D), Monat (M) und Jahr (Y) enthalten.Diese Komponenten können in einem der folgenden Formate auftreten:MM TT JJJJTT MM JJJJJJJJ MM TTTag und Monat müssen durch eine zweistellige Zahl angegeben werden.Sie können eine Tageszeit in folgendem Format hinzufügen:hh:mm:ss

Abschnitt "Benutzerautorisierungsmerkmale"

Der Abschnitt Benutzerautorisierungsmerkmale ist optional. Über Benutzerautorisierungsmerkmale werden angepasste Berechtigungsgruppen für den Zugriff auf Datenbankmerkmale festgelegt. Dieser Abschnitt enthält ein oder mehrere access-Elemente.

<access>

Wird benutzt, um die Fähigkeit zum Lesen oder Bearbeiten von angepassten Merkmalen zu definieren. Sie verwenden die Zugriffsebenen in dem Element docProperty. Sie können eine der von RICOH ProcessDirector bereitgestellten Standardsicherheitsgruppen oder aber eigene Sicherheitsgruppen verwenden. Es gibt folgende Attribute:

Attribute für das Element "access"

Attribute für "access"	Anmerkungen
name	Name der Zugriffsebene.
groupAttributeAccess	Die Fähigkeit einer Benutzergruppe zum Lesen oder Bearbeiten des Attributs.

RICOH ProcessDirector stellt folgende Standardzugriffsebenen und -berechtigungen bereit:

Standardzugriffsebenen und -berechtigungen

Zugriffsname	Gruppenname	Zugriffsebene
generische	AnyAuthenticated	Attributzugriff: lesen
	Bediener	Attributzugriff: lesen
	Aufsichtsperson	Attributzugriff: lesen
	Administrator	Attributzugriff: schreiben
attrWriteAdmin	Bediener	Attributzugriff: lesen
	Aufsichtsperson	Attributzugriff: lesen
	Administrator	Attributzugriff: schreiben
	Everyone	Attributzugriff: lesen
	Überwachungsbeauftragter	Attributzugriff: lesen
attrWriteAdminSuper	Bediener	Attributzugriff: lesen
	Aufsichtsperson	Attributzugriff: schreiben
	Administrator	Attributzugriff: schreiben
	Everyone	Attributzugriff: lesen
	Überwachungsbeauftragter	Attributzugriff: lesen
attrWriteAdminSuperOper	Bediener	Attributzugriff: schreiben
	Aufsichtsperson	Attributzugriff: schreiben
	Administrator	Attributzugriff: schreiben
	Everyone	Attributzugriff: lesen
	Überwachungsbeauftragter	Attributzugriff: lesen
actionAdmin	Bediener	Aktionszugriff: falsch
	Aufsichtsperson	Aktionszugriff: falsch
	Administrator	Aktionszugriff: richtig
	Everyone	Aktionszugriff: falsch
	Überwachungsbeauftragter	Aktionszugriff: falsch
actionAdminSuper	Bediener	Aktionszugriff: falsch
	Aufsichtsperson	Aktionszugriff: richtig
	Administrator	Aktionszugriff: richtig
	Everyone	Aktionszugriff: falsch
	Überwachungsbeauftragter	Aktionszugriff: falsch
actionAdminSuperOper	Bediener	Aktionszugriff: richtig
	Aufsichtsperson	Aktionszugriff: richtig
	Administrator	Aktionszugriff: richtig
	Everyone	Aktionszugriff: falsch
	Überwachungsbeauftragter	Aktionszugriff: falsch

Automatisch definierte Dokumentmerkmale

In dieser Tabelle werden Dokumentmerkmale aufgelistet, die RICOH ProcessDirector automatisch während der Installation definiert. Definieren Sie diese Merkmale nicht in der Datei docCustomDefinitions.xml.