É possível criar uma definição de relatório ou usar um dos seis arquivos
de definição entregues com o IBM® Enterprise
Records e
armazenados em um armazenamento de objetos de plano de arquivos.
IBM Enterprise
Records inclui seis definições de
relatório que fornecem uma visualização estatística de diferentes atividades do
usuário. Essas definições são incluídas no armazenamento de objetos de plano de
arquivos (FPOS) por meio de um Add-On instalado com o software. Os arquivos estarão
localizados em
Gerenciamento de Registros/Definições de
Relatório, mas apenas depois de serem configurados manualmente. Para
obter mais informações sobre a configuração, consulte o tópico Configurando
Definições de Relatório no
IBM Enterprise
Records Installation and Upgrade Guide. Cada definição de relatório é um documento XML e define os metadados a seguir para o
relatório:
- Título do Relatório
- Descrição do relatório
- Entrada de ajuda de relatório
- Nome da tabela de banco de dados do relatório
- Nome do modelo de relatório
- Parâmetros de Relatório
- Consultas de Relatório
Título do Relatório
O
título do relatório é o título do relatório exibido 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 que o
IBM Enterprise
Records exibe descrevendo resumidamente
o propósito do relatório. Por exemplo: Este relatório mostra apenas as ações que foram
executadas após a ativação da auditoria em uma categoria de registro, pasta, volume ou
registro.
<setting key="desc"
localizationKey="server.report_desc.n">description</setting>
Entrada de ajuda de relatório
A entrada de
ajuda é o texto que o IBM Enterprise
Records
exibe na entrada de ajuda do relatório. Por exemplo: "O relatório gerado lista apenas
as ações que foram executadas depois da ativação da auditoria."
<setting key="entryhelp"
localizationKey="server.entryhelp.n">entry
help</setting>
Nome da tabela de banco de dados do relatório
O
nome da tabela é um nome de tabela de banco de dados que o
mecanismo de relatório do IBM Enterprise
Records usa
para recuperar os resultados do repositório do
IBM Enterprise
Records.
Esse nome também é usado para produzir os resultados em uma tabela de banco de dados
intermediária que os aplicativos de relatório podem usar. 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 em um aplicativo de
relatórios.
<setting key="reportName"
localizationKey="server.report_name.n">report
name</setting>
Parâmetros de Relatório
Define parâmetros de relatório
como locais do plano de arquivos, ações, eventos, planejamentos, datas e tipos de
entidade e se eles são obrigatórios. Para definir os parâmetros do relatório:
- Em <object key="reportDefinition">, defina
<list key="report parameters">, se necessário.
- Em chave de lista de parâmetro de relatório, defina a chave de configuração de
nome simbólico, conforme necessário, para cada critério de relatório.
- Siga cada chave de configuração de nome simbólico com esta tag:
<setting key="required"> 0 ou 1
</setting>, para indicar se um valor é obrigatório. 0 indica
que o usuário não é obrigado a fazer uma seleção ou inserir um valor. 1 indica que o
usuário é obrigado a fazer uma seleção.
- Coloque cada par de nomes simbólicos e chaves de configuração obrigatórias na
tag a seguir: <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 quaisquer uma das
chaves de configuração a seguir:
- fileplan_browse: Instrui o IBM Enterprise
Records
a permitir que o usuário navegue para um local no armazenamento de objetos de plano
de arquivos.
- fileplan_name: Um planejamento de arquivos no armazenamento de objetos de plano
de arquivos (FPOS).
- ros_name: Um nome de Records Object Store (ROS).
- user_name: O nome do usuário que concluiu as atividades.
- 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.
- disposal_schedule: O planejamento da disposição associado a uma entidade.
- hold_name: A suspensão de registro associada a uma entidade.
Um
relatório também usa tipos de entidade como critério. Para usar tipos de entidade:
- Debaixo da 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>
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>
em que:
- EntityType é RecordCategory, RecordFolder, Volume 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 anteriormente.
- Entity é Categoria de Registro, Pasta de Registro, Volume ou
Registro.
Os ambientes localizados requerem
localizationKey.
Por exemplo, se
seu relatório incluir estatísticas sobre Categorias de Registro e Pastas de
Registro, esta seção do arquivo XML deverá ser semelhante ao exemplo a seguir:
<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 de Relatório
Cada relatório
entregue com o
IBM Enterprise
Records define uma ou
mais consultas para consultar diferentes tipos de entidades, como Categoria de
Registro, Pasta de Registro, Volume ou Registro. Para definir uma consulta de relatório:
- Em <object key="reportDefinition">, defina
<list key="report queries">.
- Em chave de lista de consultas de relatório, defina a consulta, conforme
necessário, para cada critério de relatório.
- Siga cada chave de configuração de consulta, defina uma configuração para
rm_entity_type para indicar que a consulta é para um tipo de
entidade específico, RecordCategory, RecordFolder, Volume ou Record. O
rm_entity_type é opcional, caso a consulta seja para todos os
tipos de entidade.
- Coloque cada consulta e chave de configuração de tipo de entidade na seguinte
tag: <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>