IBM Enterprise Records, wersja 5.1.2    

Dodawanie raportu do pliku ReportDefinitions.xml

Przed dodaniem raportu do pliku ReportDefintions.xml należy utworzyć szablon w narzędziu Crystal Reports Designer.

Procedura

Aby dodać raport do pliku ReportDefinitions.xml:

  1. Użyj edytora XML, aby otworzyć plik ReportDefinitions.xml, który znajduje się w ścieżce <ścieżka_instalacji_ier>\Config.
  2. Odszukaj tablicę dla modelu danych, która jest używana w składnicy obiektów kartoteki akt (FPOS). Plik xml zawiera tablicę dla raportów DoD, raportów sklasyfikowanych DoD, raportów PRO i raportów BASE.
  3. Dodaj znacznik value (na przykład: <value>42</value>). Ta wartość jest liczbą całkowitą, która identyfikuje raport utworzony w narzędziu Crystal Reports Designer, a ponadto jest unikalna dla każdego raportu. Ta wartość jest unikalna dla liczby istniejących raportów plus 1.
  4. W sekcji <List key="ReportDefinitions"> dodaj <object key="reportDefinition"> dla nowego raportu. Jeśli istnieje raport, który jest podobny do raportu utworzonego:
    1. Skopiuj cały klucz obiektu reportDefinition istniejącego raportu do pliku XML.
    2. Wklej skopiowany klucz obiektu do innego miejsca w pliku XML.
  5. Zmodyfikuj klucz obiektu reportDefinition dla nowego raportu, zmieniając lub dodając wartości dla następujących znaczników (odpowiednio do potrzeb).

    n to liczba wprowadzona wcześniej w kroku 3.

    <setting key="id">n</setting>.

    <setting key="title" localizationKey="server.report_title.n">nazwa raportu</setting>, gdzie nazwa raportu to tytuł raportu wyświetlanego w produkcie IBM® Enterprise Records.

    <setting key="desc" localizationKey="server.report_desc.n">opis</setting>, gdzie opis to tekst wyświetlany w produkcie IBM Enterprise Records - jest to krótki tekst opisujący przeznaczenie raportu. Na przykład: "Ten raport zawiera listę woluminów, jakie zostały otwarte/zamknięte w konkretnym okresie".

    <setting key="reportName" localizationKey="server.report_name.n">nazwa_pliku.rpt</setting>, gdzie nazwa_pliku to nazwa szablonu raportu utworzonego w Crystal Reports Designer.

    <setting key="img">ścieżka względna do pliku graficznego</setting> Ta wartość jest opcjonalna i umożliwia wstawienie pliku graficznego. Na przykład: images/action/report.gif.

  6. Aby wykluczyć nowy raport z istniejącej składnicy obiektów kartoteki akt (FPOS), wprowadź następujące znaczniki:

    <array key="excludedObjectStores"> <value>fpos</value> </array>

    gdzie fpos to nazwa składnicy obiektów FPOS, z której nowy raport został wykluczony. W celu wykluczenia raportu z więcej niż jednej składnicy obiektów FPOS należy dodać dodatkowe znaczniki value.

  7. Dodaj kryteria raportu, takie jak lokalizacje, czynności, zdarzenia, harmonogramy i daty dotyczące składnicy obiektów FPOS.
    1. Pod sekcją <object key="reportDefinition"> dodaj (w razie potrzeby) fragment <list key="properties">. Jeśli klucz obiektu reportDefinition został skopiowany z istniejącego raportu, wówczas <list key="properties:> istnieje.
    2. Pod sekcją klucza listy właściwości dodaj lub zmodyfikuj klucz ustawienia nazwy symbolicznej - odpowiednio dla każdego kryterium raportu. Jeśli utworzono jakiekolwiek kryteria, wówczas w tym miejscu należy również dodać klucze ustawień nazwy symbolicznej dla nowych kryteriów.

      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ść.

      Każdą parę nazw symbolicznych i wymaganych kluczy ustawień umieść w takim znaczniku: <object key="property"> </object>.

    Na przykład:

    <object key="property"> <setting key="symbolicname">nazwa symboliczna</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.
    • ros_browse - ustawia aplikację IBM Enterprise Records w taki sposób, aby zezwalała użytkownikowi na przeglądanie do lokalizacji w składnicy obiektów akt.
    • start_date - data rozpoczęcia kryterium raportu.
    • end_date - data zakończenia kryterium raportu.
    • application_type - typ akt, które zostaną wykorzystane jako kryteria, np. PDF, DOC, XLS i inne.
    • security_category - oznaczenie zabezpieczeń, takie jak sklasyfikowane, tajne, poufne i inne - w zależności od modelu danych.
    • review_decision - decyzja dot. przeglądu, np. o Zatwierdź lub Odrzuć.
    • action - czynność dotycząca obiektu, np. otwieranie lub zamykanie.
    • disposal_schedule - harmonogram rozporządzania powiązany z obiektem.
    • disposal_action - czynność rozporządzania dotycząca obiektu, np. przeniesienie, odtworzenie, tymczasowe przeniesienie lub zniszczenie.
    • disposal_action_export - Czynność rozporządzenia dotycząca obiektu po eksporcie.
    • report_type - stanowi dla produktu IBM Enterprise Records instrukcję z informacją o konieczności aktywowania przełączników Summary i Detailed.
    • disposal_trigger - zdarzenie, które wyzwala rozporządzenie obiektu, takie jak data, zamknięcie kontenera lub zdarzenie zewnętrzne.
    W przypadku wartości ros_browse, security_category, disposal_action, disposal_action_export, review_decision i disposal_trigger produkt IBM Enterprise Records odczytuje wartości domyślne z Content Engine w czasie wykonywania. Są one wyświetlane w menu, z którego można wybrać wartość.
  8. Jeśli w raporcie wykorzystywane są typy obiektów jako kryteria:
    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=nie wymagane). Na przykład:
      <object key="property">
      		<setting key="symbolicname">entity_type</setting>
        	<setting key="required">1</setting>
    2. 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

      • EntityType to KategoriaAkt, FolderAkt lub Akta. Można dołączyć wszystkie trzy typy, ale należy je umieścić w osobnych znacznikach <object key="value">.
      • n to liczba określona wcześniej w kroku 3.
      • Obiekt to Kategoria akt, Folder akt lub Akta.

      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 jest podobna do poniższego przykładu:

      <object key="property">   
      		<setting key="symbolicname">entity_type</setting>
        <setting key="required">1</setting>   
      		<list key="values">
          <object key="value">   
      				<setting key="id">RecordCategory</setting>
        			<setting key="value" localizationKey=serve.report_42.RecordCategory">Record
      Category</setting>     
      		 </object>      
      		 <object key="value">
        			<setting key="id">RecordFolder</setting>   
      				<setting key="value" localizationKey=serve.report_42.RecordFolder">Record Folder</setting>
          </object>    
      		</list> 
      </object>
  9. Jeśli w raporcie wykorzystywane są czynności klasyfikacji:
    W kluczu listy właściwości dodaj nazwę symboliczną classification_action, a po niej klucz ustawienia o wartości "required" (wymagane) (1=wymagane, 0=nie wymagane). Na przykład:
    <object key="property">   
    		<setting key="symbolicname">classification_action</setting>   
    		<setting key="required">1</setting>
    Dodaj <list key="values">, gdzie zostaną wprowadzone czynności klasyfikacji, 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">ClassificationAction</setting>      
    			<setting key="value" localizationKey=serve.report_n.ClassificationAction">ClassificationAction</setting>    
    		</object> 
    gdzie:
    • ClassificationAction to Aktualizowanie, Przywracanie starszej wersji lub Anulowanie klasyfikacji. Można dołączyć wszystkie trzy czynności klasyfikacji, ale należy je umieścić w osobnych znacznikach <object key="value">.
    • n to wartość "id" tego raportu w tablicy dla modelu danych.
    W środowiskach zlokalizowanych wymagany jest klucz "localizationKey."

    Na przykład: jeśli raport zawiera statystyki dotyczące przywracania wcześniejszej wersji oraz anulowania klasyfikacji, wówczas ta sekcja pliku XML jest podobna do poniższego przykładu:

    <object key="property">   
    		<setting key="symbolicname">classification_action</setting>
      	<setting key="required">1</setting>   
    		<list key="values">
        	<object key="value">   
    				<setting key="id">Downgrading</setting>
      			<setting key="value" localizationKey=serve.report_42.Downgrading">Downgrading</setting>
         	</object>      
    		  <object key="value">   
    				<setting key="id">Declassification</setting>
      			<setting key="value" localizationKey=serve.report_42.Declassification">Declassification</setting>
         </object>    
    		</list> 
    </object>
  10. Po wprowadzeniu wszystkich kryteriów raportu:
    1. Zamknij sekcję <list key="properties"> znacznikiem </list>.
    2. Zamknij sekcję <object key="reportDefinition"> znacznikiem </object>
    3. Zapisz plik XML.
  11. Aby aktywować zmiany, zrestartuj serwer aplikacji WWW, na którym działa produkt IBM Enterprise Records.

Wyniki

Po zakończeniu wprowadzania modyfikacji sekcja klucza obiektu reportDefinition wygląda jak następująca sekcja przykładowa:

<object key="reportDefinition">   
	<setting key="id">22</setting>
  <setting key="title" localizationKey="server.report_title.42">Records
Manager Classification Update Report</setting>   
	<setting key="desc" localizationKey="server.report_desc.42">This report lists entities
that have changed classification within a specific period.</setting>
  <setting key="url">RMViewReport.jsp</setting>   
	<setting key="img">images/action/report.gif</setting>   
	<setting key="reportName" localizationKey="server.report_name.42">Classification Update.rpt</setting>
  		<list key="properties">     
		<object key="property">   
			<setting key="symbolicName">fileplan_browse</setting>   
			<setting key="required">0</setting>
    </object>      
	  <object key="property">   
			<setting key="symbolicName">start_date</setting>
  			<setting key="required">1</setting>     
	  </object>      
	  <object key="property">   
			<setting key="symbolicName">end_date</setting>
  			<setting key="required">1</setting>     
		</object>      
		<object key="property">   
			<setting key="symbolicName">report_type</setting>
  			<setting key="required">0</setting>     
		</object>      
		<object key="property">   
			<setting key="symbolicname">entity_type</setting>
  			<setting key="required">1</setting>   
			<list key="values">
    			<object key="value">     
					<setting key="id">RecordCategory</setting>
    				<setting key="value" localizationKey=serve.report_42.RecordCategory">Record
Category</setting>     
				</object>      
				<object key="value">
    				<setting key="id">RecordFolder</setting>     
					<setting key="value" localizationKey=serve.report_42.RecordFolder">Record Folder</setting>
    			</object>      
				<object key="property">     
					<setting key="symbolicname">classification_action</setting>
    				<setting key="required">1</setting>     
					<list key="values">
    					<object key="value">     
							<setting key="id">Downgrading</setting>
    						<setting key="value" localizationKey=serve.report_42.Downgrading">Downgrading</setting>
     				</object>      
						<object key="value">     
							<setting key="id">Declassification</setting>
    						<setting key="value" localizationKey=serve.report_42.Declassification">Declassification</setting>
     				</object>     
					</list>      
				</object>    
			</list> 
    </object>    
	</list> 
</object>


Opinia

Ostatnia aktualizacja: Listopad 2013
add_report_definition.htm

© Copyright IBM Corp. 2013