IBM Enterprise Records バージョン 5.1.2    

ReportDefinitions.xml へのレポートの追加

レポートを ReportDefintions.xml に追加する前に、Crystal Reports Designer でレポート・テンプレートを作成します。

手順

レポートを ReportDefinitions.xml に追加するには、次のようにします。

  1. XML エディターを使用して、<ier_install_path>¥Config にある ReportDefinitions.xml を開きます。
  2. ファイル・プラン・オブジェクト・ストア (FPOS) で使用するデータ・モデルの配列を見つけます。 xml ファイルには、DoD レポート、DoD 分類レポート、PRO レポート、および BASE レポートの配列が含まれています。
  3. value タグを追加します (例えば <value>42</value>)。 この値は、Crystal Reports Designer で作成したレポートを識別する整数であり、レポートごとに固有です。 この値は、既存のレポートの数に 1 を加えた数と等しくなっています。
  4. <List key="ReportDefinitions"> の中に、新規レポートの <object key="reportDefinition"> を追加します。 作成したレポートに類似した既存のレポートがある場合は、以下のようにします。
    1. XML ファイル内の既存のレポートの reportDefinition オブジェクト・キー全体をコピーします。
    2. コピーしたオブジェクト・キーを、XML ファイルの別の場所に貼り付けます。
  5. 必要に応じて以下のタグの値を変更または追加して、新規レポートの reportDefinition オブジェクト・キーを変更します。

    n は、上記のステップ 3 で入力した数です。

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

    <setting key="title" localizationKey="server.report_title.n">report name</setting>。ここで report nameIBM® Enterprise Records が表示するレポートのタイトルです。

    <setting key="desc" localizationKey="server.report_desc.n">description</setting>。ここで description は、IBM Enterprise Records が表示するテキストであり、レポートの目的を簡潔に説明するものです。 例えば、「このレポートは、指定された期間内に開かれた/閉じられたボリュームをリストします。」などのテキストです。

    <setting key="reportName" localizationKey="server.report_name.n">filename.rpt</setting>。ここで filename は、Crystal Reports Designer で作成したレポート・テンプレートの名前です。

    <setting key="img">relative path to image file</setting>。これは、図を挿入するためのオプションの値です。 例えば、images/action/report.gif と指定します。

  6. 特定のファイル・プラン・オブジェクト・ストア (FPOS) から新規レポートを除外するには、以下のタグを入力します。

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

    ここで fpos は、新規レポートが除外される FPOS の名前です。 さらに value タグを追加すると、複数の FPOS からレポートを除外できます。

  7. FPOS ロケーション、アクション、イベント、スケジュール、および日付などのレポート基準を追加します。
    1. 必要な場合は、<object key="reportDefinition"> の下に <list key="properties"> を追加します。 既存のレポートから reportDefinition オブジェクト・キーをコピーした場合は、<list key="properties:> が存在します。
    2. プロパティー・リスト・キーの下で、各レポート基準の必要に応じて、シンボル名設定キーを追加または変更します。 基準を作成した場合、ここで新規基準のシンボル名設定キーも追加します。

      各シンボル名設定キーの後に、<setting key="required"> 0 または 1 </setting> タグを置いて、値が必要であるかどうかを指定します。 0 は、ユーザーが選択を行ったり値を入力したりする必要がないことを示します。 1 は、ユーザーが選択を行ったり値を入力したりする必要があることを示します。

      シンボル名と required 設定キーのペアのそれぞれを、<object key="property"> </object> タグで囲みます。

    次に例を示します。

    <object key="property"> <setting key="symbolicname">symbolic name</setting> <setting key="required">1</setting> </object>

    ここで symbolic name は、作成した新規基準か、または以下の設定キーのいずれかです。

    • fileplan_browse - ユーザーにファイル・プラン・オブジェクト・ストア内のロケーションの参照を許可するように、IBM Enterprise Records に指示します。
    • ros_browse - ユーザーにレコード・オブジェクト・ストア内のロケーションの参照を許可するように、IBM Enterprise Records に指示します。
    • start_date - レポート基準の開始日。
    • end_date - レポート基準の終了日。
    • application_type - PDF、DOC、XLS などの、基準として使用するレコードのタイプ。
    • security_category - データ・モデルに応じたセキュリティー・マーキング (classified、secret、confidential など)。
    • review_decision - レビューの判断。「承認」または「拒否」を含みます。
    • action - オープンまたはクローズなどの、エンティティーに対するアクション。
    • disposal_schedule - エンティティーに関連付けられた廃棄スケジュール。
    • disposal_action - 転送、レビュー、暫定転送、または破棄などの、エンティティーに対する廃棄アクション。
    • disposal_action_export - エクスポート後のエンティティーに対する廃棄アクション。
    • report_type -「要約」ラジオ・ボタンまたは「詳細」ラジオ・ボタンをアクティブにするよう、IBM Enterprise Records に指示します。
    • disposal_trigger - 日付、コンテナーの終了、または外部イベントなどの、エンティティーの廃棄をトリガーするイベント。
    ros_browse、security_category、disposal_action、disposal_action_export、review_decision、および disposal_trigger の場合、IBM Enterprise Records は、実行時に Content Engine からデフォルト値を取得します。 それらがメニューに表示され、そこで値を選択できます。
  8. レポートがエンティティー・タイプを基準として使用する場合は、以下のようにします。
    1. プロパティー・リスト・キーの下で、シンボル名 entity_type を追加し、その後に "required" 設定キー (1 = 必須、0 = 不要) を付加します。 次に例を示します。
      <object key="property">
      		<setting key="symbolicname">entity_type</setting>
        	<setting key="required">1</setting>
    2. <list key="values"> を追加します。ここで、レポートに含める対象としてユーザーが選択できるエンティティー・タイプを入力します。 次に例を示します。
      <list key="values">   
      		<object key="value">     
      			<setting key="id">EntityType</setting>
           <setting key="value" localizationKey=serve.report_n.EntityType">Entity</setting>
         </object>

      各パラメーターの説明は以下のとおりです。

      • EntityType は、RecordCategory、RecordFolder、または Record です。 3 つのエンティティー・タイプをすべて含めることができますが、それぞれを別々の <object key="value"> タグで囲む必要があります。
      • n は、上記のステップ 3 で指定した数です。
      • Entity は、Record Category、Record Folder、または Record です。

      ローカライズされた環境では、「localizationKey」が必要です。

      例えば、レポートにレコード・カテゴリーおよびレコード・フォルダーに関する統計が含まれる場合、XML ファイルのこのセクションは、以下の例のようになります。

      <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. レポートが分類アクションを使用する場合は、以下のようにします。
    プロパティー・リスト・キーの下で、シンボル名 classification_action を追加し、その後に "required" 設定キー (1 = 必須、0 = 不要) を付加します。 次に例を示します。
    <object key="property">   
    		<setting key="symbolicname">classification_action</setting>   
    		<setting key="required">1</setting>
    <list key="values"> を追加します。ここで、レポートに含める対象としてユーザーが選択できる分類アクションを入力します。 次に例を示します。
    <list key="values">     
    		<object key="value">     
    			<setting key="id">ClassificationAction</setting>      
    			<setting key="value" localizationKey=serve.report_n.ClassificationAction">ClassificationAction</setting>    
    		</object> 
    ここで
    • ClassificationAction は、Upgrading、Downgrading、または Declassification です。 3 つの分類アクションをすべて含めることができますが、それぞれを別々の <object key="value"> タグで囲む必要があります。
    • n は、データ・モデルの配列内のこのレポートの「id」値です。
    ローカライズされた環境では、「localizationKey」が必要です。

    例えば、レポートにダウングレードおよび分類解除アクションに関する統計が含まれる場合、XML ファイルのこのセクションは、以下の例のようになります。

    <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. すべてのレポート基準を入力したら、以下を行います。
    1. <list key="properties"> を、</list> で閉じます。
    2. <object key="reportDefinition"> を </object> で閉じます。
    3. XML ファイルを保存します。
  11. 変更内容を有効にするには、IBM Enterprise Records が実行されている Web アプリケーション・サーバーを再起動します。

タスクの結果

変更が完了すると、reportDefinition オブジェクト・キー・セクションは、例えば以下のようになります。

<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>


フィードバック

最終更新: 2013 年 11 月
add_report_definition.htm

© Copyright IBM Corp. 2013