Um modelo de documento define a estrutura, o layout e o conteúdo de um relatório. A criação de um modelo bem-sucedido requer planejamento, desenvolvimento, teste e armazenamento do modelo.
1: Reunir Requisitos
Diferentes necessidades requerem diferentes designs. Determine as necessidades de negócios e os requisitos práticos do documento antes de iniciar o projeto de seu(s) modelo(s).
- Elementos de Dados
- Há vários elementos de modelo que exibem diferentes tipos de informações. Quais informações são necessárias para a(s) pessoa(s) que estará(ão) visualizando o documento? Quando souber disso, é possível iniciar a determinar os elemento de dados:
- Quais elementos de modelo exibem esses dados? Qual será a aparência deles no documento final?
- Há mais de uma maneira de exibir as informações? Se houver, qual exibição é mais adequada para o contexto no qual o documento será visualizado?
- Quantos dados serão necessários? Pode ser possível remover por filtro os dados desnecessários, o que pode economizar tempo ao gerar a saída de relatório.
- Tipo de saída
- Considere qual tipo de saída atenderia melhor as necessidades da(s) pessoa(s) que estará(ão) visualizando o documento. O modelo projetado pode parecer diferente quando gerado em diferentes tipos de saída. Alguns elementos são otimizados para exibição em um formato específico e alguns não são suportados em determinados formatos. Familiarize-se com a maneira como elementos do modelo são exibidos em diferentes formatos de saída. Isso permite selecionar elementos e tipo de saída que funcionam melhor juntos.
- Um modelo vs. muitos modelos
- Esse é um modelo de uso único ou você poderia reutilizar algumas das partes em outros modelos?
- Um modelo: É possível usar um modelo para conter todas as diferentes partes do design do documento. Isso significa que tudo está em um local e nenhuma mesclagem é necessária.
- Muitos modelos: É possível usar uma abordagem modular, criando diversos modelos que possam, então, ser mesclados juntos para criarem um documento completo. Por exemplo, você pode ter um modelo de índice, um modelo de capa frontal, um modelo de dados, um modelo de índice e um modelo de capa traseira. Esses modelos podem ser reutilizados na geração de documentos diferentes.
Determine o número de modelos necessários considerando estes requisitos. É possível denominar e descrever cada bloco de modelo nos atributos de metadados. O conteúdo do nome é exibido no modelo e o conteúdo da descrição é exibido no campo de sugestão do elemento do modelo.
- Visualizando contexto
- Como alguém visualizará este documento?
- Ele será impresso? Visualizado na tela? Ambos?
- Será executado em um produto integrado?
2: Projetar um modelo
Ao projetar
um modelo, as táticas a seguir podem ajudá-lo a usar seu tempo
de forma eficiente.
- Implemente a estrutura geral do modelo usando uma abordagem de cima para baixo. Inicie com os elementos mais gerais e, em seguida, de forma incremental, limite até os detalhes.
- Valide a geração de dados antes de focar os detalhes da formatação.
Se você gastar muito tempo formatando e, em seguida, descobrir que seus dados não estão sendo gerados corretamente, pode ser necessário reformatar. Consulte 3. Testar o modelo para obter detalhes.
- Dê uma polida nos detalhes e inclua requisitos mais detalhados um a um.
Deixe detalhes menos importantes ou os difíceis para implementação posterior.
Considere a relevância de requisitos que são difíceis de realizar, como o faria em uma análise de custo-benefício.
- Considere usar scripts para extrair informações em um formato que o Rational Publishing Engine possa consumir de forma eficiente.
- Um modelo pode ser projetado para fornecer propriedades de layout da página específicas, como tamanho da página, orientação, margens, número de colunas e estilos para os tipos de parágrafos que mais provavelmente serão usados em documentos.
- Um modelo pode conter:
- Elementos de estrutura do documento, como parágrafos, tabelas, listas e um índice.
- Blocos de layout do documento, como páginas master, folhas de estilo, cabeçalhos e rodapés.
- Estilos internos e externos definidos pelo usuário, como formatação de texto ou de parágrafo. A formatação de texto inclui negrito, itálico, sublinhado, tamanho da fonte e cor da fonte. A formatação de parágrafo inclui margens, bordas, indentação e
parâmetros de script na forma de JavaScript.
- Conteúdo de modelo integrado, como imagens, texto estático e referências a arquivos estáticos e folhas de estilo.
- Elementos de dados, como atributos, condições e elementos de dados dinâmicos.
- Extração de dados na forma de consultas e filtros.
- Variáveis externas que recebem valores no tempo de execução e variáveis internas que são usadas para cálculos. A criação de variáveis externas é preferível a URLs de origem de dados com codificação permanente em seu modelo. Se URLs com codificação permanente e o nome do servidor forem alterados, então, você deve atualizar as URLs em cada modelo. Com variáveis externas, é possível substituir as URLs no tempo de execução. Para modelos integrados a outros produtos, use as variáveis especiais reconhecidas por esses produtos quando estão fazendo referência aos dados.
- Inicie o Document Studio.
- Crie um novo modelo, desde o início ou com base em um modelo existente.
- Inclua o esquema da origem de dados.
- Inclua elementos.
- Inclua formatação nos elementos.
- Defina conteúdo dinâmico.
- Opcional: Refine os dados com filtros, classificações ou condições.
3: Testar o Modelo
- O teste é feito de forma incremental durante o desenvolvimento. Salve frequentemente e salve com nomes exclusivos. Verifique a saída frequentemente usando um pequeno conjunto de dados de teste. Não inclua elementos adicionais até o que você já tem estar funcionando.
- Após desenvolver a maior parte do documento, execute teste de carregamento pare verificar problemas de desempenho. Use a ferramenta Visualização para limitar o tamanho dos dados que estão sendo usados. O relatório gerado ainda está preciso, mas é executado mais rapidamente porque o máximo de registros padrão por consulta que o Rational Publishing Engine recupera é 10 registros. Ao testar condições, é possível que nenhum registro dos 10 primeiros corresponda à condição. Nesse caso, use a ferramenta Executar em vez de a ferramenta Visualização ou altere o valor para o número máximo de registros por consulta em Preferências.
- Teste o modelo em diferentes formatos de saída. Você pode descobrir que um tipo de saída não exibe seu modelo tão bem quanto outro tipo de saída.
- Execute a ferramenta de verificação.
- Gere uma visualização.
4: Armazenar o Modelo
- Salve os modelos desenvolvidos e testados no Document Builder.
- Certifique-se de que algumas informações sejam fornecidas nos metadados do modelo de forma que outros saibam como reutilizar o modelo. Alguns dados de amostra e informações de especificação do documento de amostra para os dados do projeto ajudam na reutilização efetiva desses modelos.
Próximas etapas
Após ter criado e testado o(s) modelo(s):