Pode criar uma definição de relatório ou utilizar um dos seis ficheiros de definições fornecidos com o IBM® Enterprise
Records e guardados no armazenamento de objectos do plano de ficheiros.
O
IBM Enterprise
Records inclui seis
definições de relatório que fornecem uma visão estatística das diferentes
actividades dos utilizadores. Estas definições são adicionadas ao
armazenamento de objectos do plano de ficheiros (FPOS) através do suplementos instalado com o software. Os ficheiros encontram-se em
Records Management/Report
Definitions, mas apenas depois de ser serem configurados manualmente. Para obter mais informações sobre a configuração, consulte o tópico sobre
configurar definições de relatório no
Manual de Instalação e Actualização do
IBM Enterprise Records. Cada definição de relatório é um documento XML e define os metadados seguintes para o relatório:
- Título do relatório
- Descrição do relatório
- Entrada de ajuda do relatório
- Nome da tabela de bases de dados do relatório
- Nome do modelo de relatório
- Parâmetros de relatório
- Consultas do relatório
Título do relatório
O título do
relatório é o título do relatório apresentado pelo IBM Enterprise
Records.
<setting
key="title" localizationKey="server.report_title.n">report
title</setting>
Descrição do relatório
A
descrição é o texto apresentado pelo
IBM Enterprise
Records, que descreve resumidamente a finalidade do relatório. Por exemplo, Este relatório apresenta apenas as acções executadas após
activar a auditoria em uma categoria de registo, pasta, volume ou registo.
<setting key="desc"
localizationKey="server.report_desc.n">description</setting>
Entrada de ajuda do relatório
A ajuda
de entrada é o texto apresentado pelo
IBM Enterprise
Records na entrada de ajuda do relatório. Por exemplo, "O relatório gerado apresenta apenas as acções executadas após activar a auditoria."
<setting
key="entryhelp" localizationKey="server.entryhelp.n">entry
help</setting>
Nome da tabela de bases de dados do relatório
O
nome da tabela é o nome da tabela de bases de dados
utilizada pelo motor de relatórios do
IBM Enterprise
Records para obter os
resultados do repositório do
IBM Enterprise
Records.
Este nome também é utilizado para produzir os resultados numa tabela de
bases de dados intermédia que as aplicações do relatório podem utilizar. Por exemplo, ActionPerformed.
<setting
key="db_table_name">table name</setting>
Nome do modelo de relatório
O nome do
relatório é o nome do modelo de relatório criado numa aplicação de relatórios.
<setting key="reportName" localizationKey="server.report_name.n">report
name</setting>
Parâmetros de relatório
Define os parâmetros do
relatório, tais como, localizações do plano de ficheiros, acções, eventos,
agendas, datas e tipos de entidade, e se é requerido. Para definir parâmetros do relatório:
- Em <object key="reportDefinition">, defina <list
key="report parameters">, se necessário.
- Na chave da lista de parâmetros do relatório, defina a chave de definição do nome
simbólico, conforme necessário, para cada critério do relatório.
- Siga cada chave de definição de nome simbólico utilizando o controlo
seguinte: <setting key="required"> 0 ou 1
</setting>, para indicar se um valor é requerido. 0
indica que o utilizador não tem de efectuar uma selecção ou introduzir um
valor. 1 indica que o utilizador tem de efectuar uma selecção.
- 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 aceder a uma localização no armazenamento de objectos do plano
de ficheiros.
- fileplan_name: Um plano de ficheiros no armazenamento de objectos do plano de ficheiros (FPOS).
- ros_name: O nome de um armazenamento de objectos de registos (ROS).
- user_name: O nome do utilizador que realizou as actividades.
- 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.
- disposal_schedule: A agenda de eliminação associada a uma entidade.
- hold_name: A retenção de registo associada a uma entidade.
Um relatório também utiliza tipos de entidades como critério. Para utilizar tipos de entidades:
- Na chave da lista de propriedades, adicione o nome simbólico 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>
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,
Volume, 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 previamente identificado.
- Entidade é Categoria de registo, Pasta de registo, Volume, 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 terá de ser
semelhante ao seguinte exemplo:
<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>
Consultas do relatório
Cada
relatório fornecido com o
IBM Enterprise
Records define uma ou mais
consultas para consultar diferentes tipos de entidade, tais como, Categoria de registos, Pasta de registos, Volume ou Registo. Para definir uma consulta de relatório:
- Em <object key="reportDefinition">, defina <list
key="report queries">.
- Na chave da lista de consultas do relatório, defina a consulta,
conforme necessário, para cada critério do relatório.
- Siga cada chave de definição da consulta, defina um valor para
rm_entity_type para indicar que a consulta se destina a
um tipo de entidade, RecordCategory, RecordFolder, Volume, ou Registo específico. O valor rm_entity_type é opcional, se a consulta se destinar a todos os tipos de entidades.
- Inclua cada chave de definição do tipo de entidade e consulta no
controlo seguinte: <object
key="query"></object>.
Por exemplo:
<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">RecordCatagory</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">RecordFolder</setting>
</object>
<list>