Sie können eine Berichtsdefinition erstellen oder eine der sechs Definitionsdateien verwenden, die im Lieferumfang von IBM® Enterprise Records enthalten sind und in einem Aktenplan-Objektspeicher gespeichert sind.
IBM Enterprise Records enthält sechs Berichtsdefinitionen mit statistischen Ansichten der verschiedenen Benutzeraktivitäten. Diese Definitionen werden dem Aktenplan-Objektspeicher (File Plan Object Store, FPOS) über ein mit der Software installiertes Add-on hinzugefügt. Die Dateien befinden sich unter
Records Management/Report Definitions, jedoch nur nach deren manueller Konfiguration. Weitere Informationen zur Konfiguration finden Sie im Handbuch
IBM Enterprise Records Installation and Upgrade Guide im Abschnitt zum Konfigurieren von Berichtsdefinitionen. Jede Berichtsdefinition entspricht einem XML-Dokument und definiert die folgenden Metadaten für den Bericht:
- Berichtstitel
- Berichtsbeschreibung
- Berichtshilfeeintrag
- Tabellenname in Berichtsdatenbank
- Berichtsvorlagenname
- Berichtsparameter
- Berichtsabfragen
Berichtstitel
Der Berichtstitel ist der Titel des Berichts, den IBM Enterprise Records anzeigt.
<setting
key="title" localizationKey="server.report_title.n">Berichtstitel</setting>
Berichtsbeschreibung
Die Beschreibung ist der Text, den IBM Enterprise Records anzeigt, um den Zweck des Berichts kurz zu erläutern. Beispiel: "Dieser Bericht zeigt nur die Aktionen an, die ausgeführt wurden, nachdem Sie die Prüfung für eine Schriftstückkategorie, einen Ordner, einen Datenträger oder ein Schriftstück aktiviert haben."
<setting
key="desc" localizationKey="server.report_desc.n">Beschreibung</setting>
Berichtshilfeeintrag
Die Eintragshilfe ist Text, den IBM Enterprise Records im Hilfeeintrag des Berichts anzeigt. Beispiel: "Dieser generierte Bericht listet nur die Aktionen auf, die ausgeführt wurden, nachdem Sie die Prüfung aktiviert haben."
<setting
key="entryhelp" localizationKey="server.entryhelp.n">Eintragshilfe</setting>
Tabellenname in Berichtsdatenbank
Der Tabellenname ist ein Datenbanktabellenname, den die IBM Enterprise Records-Berichtsengine zum Abrufen der Ergebnisse aus dem IBM Enterprise Records-Repository verwendet.
Dieser Name wird auch zum Erzeugen der Ergebnisse in einer zwischengeschalteten Datenbanktabelle verwendet, die die Berichtsanwendungen verwenden können. Beispiel: ActionPerformed
<setting
key="db_table_name">Tabellenname</setting>
Berichtsvorlagenname
Der Berichtsname ist der Name der Berichtsvorlage, die in einer Berichtsanwendung erstellt wird.
<setting key="reportName" localizationKey="server.report_name.n">Berichtsname</setting>
Berichtsparameter
Definiert Berichtsparameter wie Aktenplan-Speicherorte, Aktionen, Ereignisse, Zeitpläne, Daten und Entitätstypen sowie die Angabe, ob der Wert erforderlich ist. So definieren Sie Berichtsparameter:
- Definieren Sie unter <object key="reportDefinition"> gegebenenfalls die Angabe <list
key="report parameters">.
- Definieren Sie unter <list
key="report parameters"> entsprechend den Berichtskriterien den Einstellungsschlüssel <setting key="symbolicname"> für den symbolischen Namen.
- Fügen Sie jedem Einstellungsschlüssel <setting key="symbolicname"> den Tag <setting
key="required"> 0 oder 1 </setting> hinzu, um anzugeben, ob ein Wert erforderlich ist. 0 gibt an, dass der Benutzer keine Auswahl treffen bzw. keinen Wert eingeben muss. 1 gibt an, dass der Benutzer eine Auswahl treffen muss.
- Schließen Sie jedes Paar von <setting key="symbolicname"> und <setting key="required"> in den Tag <object key="property"> </object> ein.
Beispiel:
<object key="property"> <setting key="symbolicname">symbolischer_Name</setting>
<setting key="required">1</setting> </object>
Dabei gilt Folgendes:
symbolischer_Name ist die neu erstellte Bedingung oder einer der folgenden Einstellungsschlüssel
<setting key>:
- fileplan_browse: Weist IBM Enterprise Records an, dem Benutzer das Navigieren zu einer Position im Aktenplan-Objektspeicher zu ermöglichen.
- fileplan_name: Gibt einen Aktenplan im Aktenplan-Objektspeicher an.
- ros_name: Gibt einen Namen für einen Objektspeicher für Schriftstücke an.
- user_name: Gibt den Namen des Benutzers an, der die Aktivitäten ausgeführt hat.
- start_date: Gibt das Startdatum der Berichtskriterien an.
- end_date: Gibt das Enddatum der Berichtskriterien an.
- disposal_schedule: Gibt den einer Entität zugeordneten Aussonderungszeitplan an.
- hold_name: Gibt die einer Entität zugeordnete Schriftstückrückstellung an.
Ein Bericht verwendet auch Entitätstypen als Kriterien. So verwenden Sie Entitätstypen:
- Fügen Sie unter dem Objektschlüssel <object key="property"> den Einstellungsschlüssel <setting key="symbolicname">entity_type</setting> gefolgt vom Einstellungsschlüssel <setting key="required"> (1=erforderlich, 0=nicht erforderlich) hinzu. Beispiel:
<object key="property">
<setting key="symbolicname">Entitätstyp</setting>
<setting key="required">1</setting>
Fügen Sie
<list key="values"> hinzu, wobei Sie die Entitätstypen eingeben, die ein Benutzer zur Aufnahme in den Bericht auswählen kann. Beispiel:
<list key="values">
<object key="value">
<setting key="id">Entitätstyp</setting>
<setting key="value" localizationKey=serve.report_n.Entitätstyp">Entität</setting>
</object>
Dabei gilt Folgendes:
- Entitätstyp ist eine Schriftstückkategorie (RecordCategory), ein Schriftstückordner (RecordFolder), ein Datenträger (Volume) oder ein Schriftstück (Record). Sie können alle drei Entitätstypen einschließen. Sie müssen sie dazu jedoch in getrennte Tags <object key="value"> aufnehmen.
- n ist die Nummer, die Sie oben eingegeben haben.
- Entität ist eine Schriftstückkategorie, ein Schriftstückordner, ein Datenträger oder ein Schriftstück.
Für lokalisierte Umgebungen ist
localizationKey erforderlich.
Wenn Ihr Bericht z. B. Statistikdaten zu Schriftstückkategorien oder Schriftstückordnern umfasst, muss dieser Abschnitt der XML-Datei etwa wie folgendes Beispiel aussehen:
<object key="property">
<setting key="symbolicName">RM-Entitätstyp</setting>
<setting key="required">1</setting>
<list key="values'>
<object key="value">
<setting key="id">RecordCategory</setting>
<setting key="value" localization Key="server.report_1.RecordCategory">Schriftstückkategorie</setting>
</object>
<object key="value">
<setting key="id">RecordFolder</setting>
<setting key="value" localization Key="server.report_1.RecordFolder">Schriftstückordner</setting>
</object>
</list>
</object>
Berichtsabfragen
Jeder Bericht, der im Lieferumfang von
IBM Enterprise Records enthalten ist, definiert mindestens eine Abfrage für verschiedene Entitätstypen wie Schriftstückkategorie, Schriftstückordner, Datenträger oder Schriftstück. So definieren Sie eine Berichtsabfrage:
- Definieren Sie unter <object key="reportDefinition"> die Angabe <list
key="report queries">.
- Definieren Sie unter <list
key="report queries"> entsprechend den Berichtskriterien die Abfrage je nach Bedarf.
- Fügen Sie jedem Einstellungsschlüssel für die Abfrage eine Einstellung für RM-Entitätstyp hinzu, um anzugeben, dass die Abfrage für einen bestimmten Entitätstyp (RecordCategory, RecordFolder, Volume oder Record) durchgeführt werden soll. Der RM-Entitätstyp ist optional, wenn die Abfrage für alle Entitätstypen gilt.
- Schließen Sie alle Einstellungsschlüssel für die Abfrage und den Entitätstyp in den folgenden Tag ein: <object key="query"></object>.
Beispiel:
<list key="report queries">
<object key="query">
<setting key="sql">SELECT EV.LastModifier, EV.DateCreated, EV.ClassDescription, EV.AuditActionType,RC.RecordCategoryName AS EntityName, RMF.PathName, RC.Aggregation FROM (Event EV INNER JOIN RecordCategory RC ON EV.SourceObjectID = RC.ID)INNER JOIN RMFOLDER RMF on RC.parent=RMF.This WHERE EV.DateCreated >= {?start_date} AND EV.DateCreated <= {?end_date} AND EV.LastModifier = '{?user_name}' AND RC.this INSUBFOLDER '/{?fileplan_name}'</setting>
<setting key="my_entity_type">RecordCategory</setting>
</object>
<object key="query">
<setting key="sql">SELECT EV.LastModifier, EV.DateCreated, EV.ClassDescription, EV.AuditActionType,RF.RecordFolderName AS EntityName,RMF.PathName, RF.Aggregation FROM (Event EV INNER JOIN RecordFolder RF ON EV.SourceObjectID = RF.ID)INNER JOIN RMFOLDER RMF on RF.parent=RMF.This WHERE EV.DateCreated >= {?start_date} AND EV.DateCreated <= {?end_date} AND EV.LastModifier = '{?user_name}' AND RF.this INSUBFOLDER '/{?fileplan_name}'</setting>
<setting key="my_entity_type">RecordFolder</setting>
</object>
<list>