IBM Enterprise Records, Versão 5.1.2    

Incluindo um Relatório em ReportDefinitions.xml

Antes de incluir um relatório no ReportDefintions.xml, crie um modelo de relatório no Crystal Reports Designer.

Procedimento

Para incluir um relatório no ReportDefinitions.xml:

  1. Use um editor XML para abrir ReportDefinitions.xml em <ier_install_path>\Config.
  2. Localize a matriz para o modelo de dados usado em seu armazenamento de objetos de plano de arquivos (FPOS). O arquivo xml contém uma matriz para relatórios DoD, relatórios DoD classified, relatórios PRO e relatórios BASE.
  3. Inclua uma identificação 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">, inclua <object key="reportDefinition">, para seu novo relatório. Se houver um relatório existente que seja semelhante ao relatório criado:
    1. Copie a chave do objeto reportDefinition inteira do relatório existente no arquivo XML.
    2. Cole a chave do objeto copiada em outro local do arquivo XML.
  5. Modifique a chave do objeto reportDefinition para seu novo relatório alterando ou incluindo valores para as seguintes tags, conforme necessário.

    n é o número inserido na etapa 3 anterior.

    <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 que o IBM® Enterprise Records exibe.

    <setting key="desc" localizationKey="server.report_desc.n">description</setting>, em que description é o texto que o IBM Enterprise Records exibe, descrevendo brevemente o propósito do relatório. Por exemplo, "Este relatório lista os volumes que foram abertos/fechados dentro de um período específico."

    <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 seu novo relatório de um armazenamento de objetos de plano de arquivos (FPOS) específico, insira as seguintes tags:

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

    em que fpos é o nome do FPOS em que o novo relatório é excluído. É possível incluir tags de valor adicionais para excluir o relatório de mais de um FPOS.

  7. Inclua critérios de relatório, tais como locais, ações, eventos, planejamentos e datas de FPOS.
    1. Sob <object key="reportDefinition">, inclua <list key="properties">, se necessário. Se você copiou a chave do objeto reportDefinition de um relatório existente, então <list key="properties:> existe.
    2. Sob a chave da lista de propriedades, inclua ou modifique a chave de configuração do nome simbólico, conforme necessário para cada um dos critérios do relatório. Se você criou algum critério, inclua aqui as chaves de configuração de nome simbólico para os novos critérios também.

      Acompanhe cada chave de configuração de nome simbólico com esta tag: <setting key="required"> 0 ou 1 </setting>, para indicar se um valor é necessário. 0 indica que o usuário não é obrigado a fazer uma seleção ou a inserir um valor. 1 indica que o usuário é obrigado a fazer uma seleção ou a inserir um valor.

      Coloque cada par de nomes simbólicos e chaves de configuração necessárias nesta tag: <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 configuração a seguir:

    • fileplan_browse - Instrui o IBM Enterprise Records para permitir que o usuário navegue até um local no armazenamento de objetos de plano de arquivos.
    • ros_browse - Instrui o IBM Enterprise Records para permitir que o usuário navegue até um local no armazenamento de objetos dos registros.
    • start_date - A data de início dos critérios de relatório.
    • end_date - A data de encerramento dos critérios de relatório.
    • application_type - O tipo de registro a usar como critério, tal como PDF, DOC, XLS e outros.
    • security_category - A marcação de segurança, tal como classificado, secreto, confidencial e outros, dependendo do modelo de dados.
    • review_decision - A decisão de uma revisão, incluindo Aprovar ou Rejeitar.
    • action - A ação em uma entidade, tal como abrir ou fechar.
    • disposal_schedule - O planejamento da disposição associado com uma entidade.
    • disposal_action - A ação de descarte em uma entidade, tal como transferir, revisar, transferência temporária ou destruir.
    • disposal_action_export - A ação de descarte em uma entidade após uma exportação.
    • report_type - Instrui o IBM Enterprise Records a ativar os botões de opções Resumo ou Detalhado.
    • disposal_trigger - O evento que aciona a disposição de uma entidade, tal como uma data, o fechamento de um contêiner ou um evento externo
    Para ros_browse, security_category, disposal_action, disposal_action_export, review_decision e acionador de descarte, o IBM Enterprise Records recupera os valores padrão do Content Engine no tempo de execução. Você os vê em um menu no qual é possível selecionar um valor.
  8. Se seu relatório usa tipos de entidade como critérios:
    1. Sob a chave da lista de propriedades, inclua o nome simbólico entity_type, acompanhado pela chave de configuração "required" (1=required, 0=not required). Por exemplo:
      <object key="property">
      		<setting key="symbolicname">entity_type</setting>
        	<setting key="required">1</setting>
    2. Inclua <list key="values"> no qual você insere os tipos de entidade que um usuário pode selecionar 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>

      onde:

      • EntityType é RecordCategory, RecordFolder ou Record. É possível incluir todos os três tipos de entidades, mas você deve colocar cada um deles entre tags <object key="value"> separadas.
      • n é o número identificado na etapa 3 anterior.
      • Entity é a Categoria de Registro, a Pasta de Registro ou o Registro.

      Ambientes localizados requerem "localizationKey."

      Por exemplo, se seu relatório incluir estatísticas sobre Categorias de Registro ou Pastas de Registro, esta seção do arquivo XML será semelhante ao exemplo a seguir:

      <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 seu relatório usar ações de classificação:
    Sob a chave da lista de propriedades, inclua o nome simbólico classification_action, acompanhado pela chave de configuração "required" (1=required, 0=not required). Por exemplo:
    <object key="property">   
    		<setting key="symbolicname">classification_action</setting>   
    		<setting key="required">1</setting>
    Inclua <list key="values"> onde você insere as ações de classificação que um usuário pode selecionar para incluir em um 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 é Atualizando, Fazendo Downgrade ou Desclassificação. É possível incluir todas as três ações de classificação, mas você deve colocar cada uma delas entre tags <object key="value"> separadas.
    • n é o valor "id" deste relatório na matriz para o modelo de dados.
    Ambientes localizados requerem "localizationKey."

    Por exemplo, se seu relatório incluir estatísticas sobre as ações fazer downgrade e desclassificação, esta seção do arquivo XML será semelhante ao exemplo a seguir:

    <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. Após você inserir todos os critérios de relatório:
    1. Feche <list key="properties"> com </list>.
    2. Feche <object key="reportDefinition"> com </object>
    3. Salve o arquivo XML.
  11. Reinicie o servidor de aplicativos da Web no qual o IBM Enterprise Records é executado para que as mudanças entrem em vigor.

Resultados

Quando você tiver concluído as modificações, a chave do objeto reportDefinition ficará semelhante ao exemplo a seguir:

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


Feedback

Última atualização: novembro de 2013
add_report_definition.htm

© Copyright IBM Corporation 2013