IBM Enterprise Records, wersja 5.1.2    

Tworzenie definicji raportu

Istnieje możliwość utworzenia definicji raportu lub użycia jednego z sześciu plików definicji udostępnionych wraz z produktem IBM® Enterprise Records i zapisanych w składnicy obiektów kartoteki akt.

Produkt IBM Enterprise Records zawiera sześć definicji raportów, które udostępniają statystyczne ujęcie różnych działań wykonywanych przez użytkowników. Definicje te są dodawane do składnicy obiektów kartoteki akt (FPOS) za pośrednictwem programu dodatkowego instalowanego wraz z oprogramowaniem. Pliki są dostępne w lokalizacji Records Management/Report Definitions, ale wymagają wcześniejszego ręcznego skonfigurowania. Więcej informacji o konfigurowaniu zawiera temat dotyczący konfigurowania definicji raportów w publikacji IBM Enterprise Records Installation and Upgrade Guide. Każda definicja raportu stanowi dokument XML i zawiera definicje następujących metadanych raportu:

Tytuł raportu

Tytuł raportu to tytuł raportu wyświetlany przez produkt IBM Enterprise Records.

<setting key="title" localizationKey="server.report_title.n">tytuł raportu</setting>

Opis raportu

Opis to tekst wyświetlany przez produktIBM Enterprise Records, stanowiący krótki opis przeznaczenia raportu. Na przykład: Ten raport dotyczy tylko czynności, które zostały zakończone po włączeniu kontroli dla kategorii akt, folderu, woluminu lub rekordu.

<setting key="desc" localizationKey="server.report_desc.n">opis</setting>

Wpis pomocy do raportu

Wpis pomocy to tekst wyświetlany przez produkt IBM Enterprise Records w pomocy raportu. Na przykład: "Wygenerowany raport zawiera tylko czynności zakończone po włączeniu kontroli."

<setting key="entryhelp" localizationKey="server.entryhelp.n">wpis pomocy</setting>

Nazwa tabeli bazy danych raportu

Nazwa tabeli to nazwa tabeli bazy danych, z której mechanizm generowania raportów IBM Enterprise Records korzysta w celu pobierania wyników z repozytorium IBM Enterprise Records. Nazwa służy również do generowania wyników w pośredniej tabeli bazy danych, z której mogą korzystać aplikacje raportów. Na przykład: ActionPerformed.

<setting key="db_table_name">nazwa tabeli</setting>

Nazwa szablonu raportu

Nazwa raportu to nazwa szablonu raportu utworzonego w aplikacji raportów.

<setting key="reportName" localizationKey="server.report_name.n">nazwa raportu</setting>

Parametry raportu

Zawierają definicje parametrów raportu, takich jak lokalizacje kartotek akt, czynności, zdarzenia, harmonogramy, daty i typy jednostek oraz informację o tym, kiedy są wymagane. Aby zdefiniować parametry raportu:
  1. W razie konieczności w sekcji <object key="reportDefinition"> zdefiniuj wartość <list key="report parameters">.
  2. W sekcji klucza listy parametrów raportu zdefiniuj odpowiedni klucz ustawienia nazwy symbolicznej dla każdego kryterium raportu.
  3. Zakończ każdy klucz ustawienia nazwy symbolicznej następującym znacznikiem: <setting key="required"> 0 lub 1 </setting>, aby wskazać, czy wartość jest wymagana. 0 oznacza, że użytkownik nie musi dokonywać wyboru ani wprowadzać wartości. 1 oznacza, że użytkownik musi dokonać wyboru lub wprowadzić wartość.
  4. Każdą parę nazw symbolicznych i wymaganych kluczy ustawień umieść w następującym znaczniku: <object key="property"></object>.
Na przykład:
<object key="property"> <setting key="symbolicname">symbolic_name</setting>
<setting key="required">1</setting> </object>
gdzie nazwa symboliczna to nowo utworzone kryteria lub dowolne z następujących kluczy ustawień:
  • fileplan_browse: ustawia aplikację IBM Enterprise Records w taki sposób, aby zezwalała użytkownikowi przeglądanie do lokalizacji w składnicy obiektów kartoteki akt.
  • fileplan_name: kartoteka akt w składnicy obiektów kartoteki akt (FPOS).
  • ros_name: nazwa składnicy obiektów akt (ROS).
  • user_name: nazwa użytkownika, który wykonał te czynności.
  • start_date: data rozpoczęcia kryterium raportu.
  • end_date: data zakończenia kryterium raportu.
  • disposal_schedule: harmonogram rozporządzania powiązany z obiektem.
  • hold_name: wstrzymany obiekt powiązany z obiektem.
W raporcie jako kryteria stosowane są również typy obiektów. Aby użyć typów obiektów:
  1. W kluczu listy właściwości dodaj nazwę symboliczną entity_type, a po niej klucz ustawienia o wartości required (wymagane) (1=wymagane, 0=niewymagane). Na przykład:
<object key="property">
    <setting key="symbolicname">entity_type</setting>
    <setting key="required">1</setting>
Dodaj <list key="values">, gdzie zostaną wprowadzone typy obiektów, które użytkownik będzie mógł wybierać w celu dołączenia do raportu. Na przykład:
    <list key="values">
       <object key="value">
           <setting key="id">EntityType</setting>
           <setting key="value" localizationKey=serve.report_n.EntityType">Entity</setting>
       </object>
gdzie: W środowiskach zlokalizowanych wymagany jest klucz localizationKey. Na przykład: jeśli raport zawiera statystyki dotyczące kategorii akt i folderów akt, wówczas ta sekcja pliku XML będzie podobna do następującego przykładu:
<object key="property">
  <setting key="symbolicName">rm_entity_type</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">Record Category</setting>
    </object>
    <object key="value">
       <setting key="id">RecordFolder</setting>
       <setting key="value" localization Key="server.report_1.RecordFolder">Record Folder</setting>
    </object>
  </list>
</object>

Zapytania dot. raportu

Każdy raport dostarczony za pomocą produktu IBM Enterprise Records zawiera definicje co najmniej jednego zapytania, dotyczącego różnych typów obiektów, takich jak Kategoria akt, Folder akt, Wolumin lub Akta. Aby zdefiniować zapytanie dot. raportu:
  1. W sekcji <object key="reportDefinition"> zdefiniuj <list key="report queries">.
  2. W sekcji klucza listy zapytań dot. raportu zdefiniuj odpowiednie zapytanie dla każdego kryterium raportu.
  3. Po każdym kluczu ustawienia zapytania zdefiniuj ustawienie dla zmiennej rm_entity_type, aby wskazać, czy zapytanie dotyczy konkretnego typu obiektu, takiego jak KategoriaAkt, FolderAkt, Wolumin lub Akta. Zmienna rm_entity_type jest opcjonalna, o ile zapytanie dotyczy wszystkich typów obiektów.
  4. Każde zapytanie i klucze ustawień typu obiektu umieść w następującym znaczniku: <object key="query"></object>.
Na przykład:
<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">KategoriaAkt</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">FolderAkt</setting>
   </object>
<list>


Opinia

Ostatnia aktualizacja: Listopad 2013
use_report_definitions.htm

© Copyright IBM Corp. 2013