IBM Enterprise Records, Versão 5.1.+            

Adicionar um relatório a ReportDefinitions.xml

Antes de adicionar um novo relatório ao ficheiro ReportDefintions.xml, crie um novo modelo de relatório no Crystal Reports Designer.

Para adicionar um novo relatório a ReportDefinitions.xml:

  1. Utilize um editor de XML para abrir o ficheiro ReportDefinitions.xml, localizado em <caminho_instalação_ier>\Config.
  2. Localize a matriz do modelo de dados utilizado no armazenamento de objectos de plano de ficheiros (FPOS). O ficheiro xml contém uma matriz para relatórios DoD, relatórios DoD Classified, relatórios PRO e relatórios BASE.
  3. Adicione um novo controlo de valor (por exemplo, <value>42</value>). Este valor é um número inteiro que identifica o relatório criado no Crystal Reports Designer, e é exclusivo para cada relatório. Este valor é igual ao número de relatórios existentes mais 1.
  4. Em <List key="ReportDefinitions">, adicione <object key="reportDefinition">, para o novo relatório. Se existir um relatório semelhante ao relatório criado:
    1. Copie toda a chave de objecto reportDefinition do relatório existente no ficheiro XML.
    2. Cole a chave de objecto copiada noutra localização do ficheiro XML.
  5. Modifique a chave de objecto reportDefinition para o novo relatório alterando ou adicionando valores para os controlos seguintes, conforme necessário.

    n é o número introduzido no passo 3 acima.

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

    <setting key="title" localizationKey="server.report_title.n">report name</setting>, em que report name é o título do relatório apresentado no IBM® Enterprise Records.

    <setting key="desc" localizationKey="server.report_desc.n">description</setting>, em que description é o texto apresentado pelo IBM Enterprise Records, que descreve resumidamente a finalidade do relatório. Por exemplo, "Este relatório indica os volumes abertos/fechados num determinado período."

    <setting key="reportName" localizationKey="server.report_name.n">filename.rpt</setting>, em que filename é o nome do modelo de relatório criado no Crystal Reports Designer.

    <setting key="img">relative path to image file</setting> Este é um valor opcional para inserir um gráfico. Por exemplo, images/action/report.gif.

  6. Para excluir o novo relatório de um armazenamento de objectos de plano de ficheiros (FPOS), introduza os controlos seguintes:

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

    em que fpos é o nome do FPOS do qual o novo relatório será excluído. Pode adicionar controlos de valor adicionais para excluir o relatório de mais de um FPOS.

  7. Adicione critérios de relatório, como por exemplo as localizações de FPOS, acções, eventos, agendas e datas.
    1. Em <object key="reportDefinition">, adicione <list key="properties">, se necessário. Se copiou a chave de objecto reportDefinition de um relatório existente, <list key="properties:> já existe.
    2. Na chave da lista de propriedades, adicione ou modifique a chave de definição do nome simbólico, conforme necessário para cada critério do relatório. Se criou critérios novos, adicione as chaves de definição do nome simbólico também para os novos critérios.

      Adicione o controlo seguinte após cada chave de definição do nome simbólico: <setting key="required"> 0 ou 1 </setting>, para indicar se um valor é necessário. 0 indica que o utilizador não tem de efectuar uma selecção ou introduzir um valor, e 1 indica que essa informação é requerida.

      Inclua cada par de nomes simbólicos e chaves de definição requeridas no controlo seguinte: <object key="property"> </object>.

    Por exemplo:

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

    em que symbolic name é o novo critério criado, ou qualquer uma das chaves de definição seguintes:

    • fileplan_browse - Indica ao IBM Enterprise Records para permitir ao utilizador procurar a localização no armazenamento de objectos de plano de ficheiros.
    • ros_browse - Indica ao IBM Enterprise Records para permitir ao utilizador procurar uma localização no armazenamento de objectos de registos.
    • start_date - A data de início dos critérios do relatório.
    • end_date - A data de fim dos critérios do relatório.
    • application_type - O tipo de registo a utilizar como critério, como PDF, DOC, XLS, e outros.
    • security_category - A marca de segurança, como por exemplo, confidencial, secreto e outros, conforme o modelo de dados.
    • review_decision - A decisão de uma revisão, incluindo a indicação Aprovar ou Rejeitar.
    • action - A acção aplicada à entidade, como por exemplo, abrir ou fechar.
    • disposal_schedule - A agenda de eliminação associada à entidade.
    • disposal_action - A acção de eliminação aplicada à entidade, como por exemplo, transferência, revisão, transferência interina ou destruição.
    • disposal_action_export - A acção de eliminação aplicada à entidade após uma exportação.
    • report_type - Indica ao IBM Enterprise Records para apresentar os selectores de opção Resumo ou Detalhado.
    • disposal_trigger - O evento que activa a eliminação de uma entidade, como por exemplo, uma data, o fecho de um contentor ou um evento externo
    Para as chaves ros_browse, security_category, disposal_action, disposal_action_export, review_decision, e disposal_trigger, o IBM Enterprise Records obtém os valores predefinidos do Content Engine durante a execução e apresenta os mesmos num menu, a partir do qual pode seleccionar um valor.
  8. Se o relatório utilizar tipos de entidades como critério:
    1. Na chave da lista de propriedades, adicione o nome simbólico de entity_type, seguido pela chave de definição "required" (1=required, 0=not required). Por exemplo:
      <object key="property">
      		<setting key="symbolicname">entity_type</setting>
        	<setting key="required">1</setting>
    2. Adicione <list key="values"> em que introduz os tipos de entidade que um utilizador pode seleccionar para incluir no relatório. Por exemplo:
      <list key="values">   
      		<object key="value">     
      			<setting key="id">EntityType</setting>
           <setting key="value"
      localizationKey=serve.report_n.EntityType">Entity</setting>
         </object>

      em que

      • EntityType é RecordCategory, RecordFolder, ou Record. Pode incluir todos os três tipos de entidade, mas estes terão de ser incluídos em controlos <object key="value"> separados.
      • n é o número identificado no passo 3 acima.
      • Entity corresponde à Categoria de registo, Pasta de registo ou Registo.

      Os ambientes localizados requerem "localizationKey."

      Por exemplo, se o relatório incluir estatísticas sobre Categorias de registo e Pastas de registo, esta secção do ficheiro XML será semelhante ao seguinte:

      <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. Se o relatório utilizar acções de classificação:
    Na chave de lista de propriedades, adicione o nome simbólico de classification_action, seguido pela chave de definição "required" setting key (1=required, 0=not required). Por exemplo:
    <object key="property">   
    		<setting key="symbolicname">classification_action</setting>   
    		<setting key="required">1</setting>
    Adicione <list key="values"> em que introduz as acções de classificação que um utilizador pode seleccionar para incluir no relatório. Por exemplo:
    <list key="values">     
    		<object key="value">     
    			<setting key="id">ClassificationAction</setting>      
    			<setting key="value" localizationKey=serve.report_n.ClassificationAction">ClassificationAction</setting>    
    		</object> 
    em que:
    • ClassificationAction corresponde a Aumentar o nível, Reduzir o nível ou Desclassificação. Pode incluir as três acções de classificação, mas estas terão de ser incluídas em controlos <object key="value"> separados.
    • n é o valor de "id" deste relatório na matriz do modelo de dados.
    Os ambientes localizados requerem "localizationKey."

    Por exemplo, se o relatório incluir estatísticas sobre acções de redução do nível e desclassificação, esta secção do ficheiro XML será semelhante ao seguinte:

    <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. Depois de ter introduzido todos os critérios do relatório:
    1. Feche <list key="properties"> com </list>.
    2. Feche <object key="reportDefinition"> com </object>
    3. Guarde o ficheiro XML.
  11. Reinicie o servidor da aplicação da Web em que o IBM Enterprise Records é executado para que as alterações sejam aplicadas.

Quando concluir as modificações, a secção da chave de objecto reportDefinition deverá ser semelhante ao seguinte:

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


Comentários

Última actualização: Agosto de 2011


© Copyright IBM Corp. 2011.
Este Information Center é baseado na tecnologia Eclipse. (http://www.eclipse.org)