Documentação de esquemas de bancos de dados

Nota  Esse recurso fica disponível quando o ajuste geral Usar ferramentas avançadas está selecionado. Consulte Uso de ferramentas avançadas.

O FileMaker Pro fornece duas formas para documentar os detalhes do seu app personalizado salvando:

  • uma cópia do arquivo no formato XML

  • um Relatório de design de banco de dados

Salvar uma cópia como XML

Você pode salvar uma cópia de um arquivo do FileMaker Pro em um formato XML que representa o esquema, os layouts, os scripts e outras partes do arquivo. Esse formato XML tem a maioria dos detalhes do arquivo, mas não tem dados do registro.

Como o arquivo XML é texto, você pode armazená-lo em sistemas de controle de versão, como o Git, e usar ferramentas padrão baseadas em texto para comparar versões.

Para salvar a cópia de um arquivo como XML:

  1. Abra o arquivo a ser salvo como XML.

    É necessário ter privilégios de acesso total no arquivo.

  2. Escolha o menu Ferramentas > Salvar cópia como XML.

  3. Altere o nome do arquivo padrão e escolha uma pasta diferente, se necessário.

  4. Para incluir informações no arquivo XML, clique em Incluir detalhes para ferramentas de análise.

    Essa opção adiciona o elemento DDR_INFO, que fornece informações adicionais úteis para ferramentas de terceiros que você pode usar para analisar seu aplicativo personalizado. Dependendo do seu aplicativo, essa opção pode produzir um arquivo XML significativamente maior.

  5. Clique em Salvar.

Notas

  • Esse formato XML pode mudar de uma versão do FileMaker Pro para a posterior. Ao usar o XML para comparar duas versões de um arquivo do FileMaker Pro, verifique se a mesma versão do FileMaker Pro é usada para salvar uma cópia de cada arquivo como XML. Se você usar o XML com outras ferramentas, verifique se essas ferramentas foram feitas para usar o XML salvo pela sua versão do FileMaker Pro.

  • Por segurança, avente a possibilidade de restringir o acesso ao arquivo XML para impedir o acesso não autorizado a informações confidenciais no arquivo.

Criação de um Relatório de design de banco de dados

Use o recurso Relatório de design de banco de dados para documentar o esquema do seu banco de dados e salve-o como um arquivo HTML ou XML.

Com o Relatório de design de banco de dados, é possível:

  • produzir relatórios para quaisquer banco de dados atualmente abertos

  • reunir estatísticas sobre a estrutura do seu banco de dados

  • usar as informações no relatório para recriar a estrutura do banco de dados se você perder os arquivos de banco de dados originais

  • examinar uma representação textual do seu esquema de banco de dados

  • escolher quais elementos (campos, relacionamentos, scripts etc.) e tabelas do banco de dados documentar

  • solucionar problemas de referências ausentes, relacionamentos interrompidos, cálculos etc.

Um Relatório de design de banco de dados em formato HTML inclui uma Visão geral do relatório, que apresenta um instantâneo da maioria dos elementos em cada arquivo de banco de dados. A Visão geral do relatório contém hiperlinks para detalhes sobre os elementos de cada arquivo de banco de dados.

Um Relatório de design de banco de dados em formato XML contém as informações sobre os elementos em cada arquivo de banco de dados e está pronto para ser transformado no formato que você solicitar.

Para criar um Relatório de design de banco de dados:

  1. Abra todos os arquivos de banco de dados para os quais deseja produzir um Relatório de design de banco de dados.

    Você precisa ter privilégios de acesso completos a qualquer arquivo para o qual deseje produzir um Relatório de design de banco de dados, e o arquivo deve ser aberto no FileMaker Pro.

  2. Escolha o menu Ferramentas > Relatório de design de banco de dados.

  3. Na lista Arquivos disponíveis, desmarque todos os arquivos que deseja excluir do relatório desmarcando a caixa de seleção associada ao arquivo.

  4. Se houver arquivos que contenham tabelas que deseja excluir do relatório, selecione o nome de arquivo, além da caixa de seleção na lista Arquivos disponíveis.

  5. Em Incluir em relatório, desmarque os elementos que deseja excluir do relatório.

  6. Se preferir publicar o relatório no formato XML em vez de no HTML padrão, selecione XML na seção Formato do relatório.

  7. Clique em Criar e depois em Salvar para salvar o relatório de design de banco de dados.

Notas

  • As informações fornecidas no relatório HTML é um subconjunto das informações fornecidas na versão em XML.

Tópicos relacionados