Relatórios Autodocumentados¶

Visão Geral¶

Novidade no Vinyl 2.4, o Vinyl introduz recursos de autodocumentação na forma de relatórios. Áreas específicas do Vinyl têm novas ofertas de relatórios disponíveis que, quando executadas, listam e descrevem informações de configuração relacionadas à área em que o relatório está disponível. Os relatórios para este recurso estão disponíveis nas seguintes áreas do Vinyl: Documento API por Endpoint, Notas de versão por aplicativo, Relatórios de auditoria por camada de Vinyl (camada UI, camada lógica de negócios, camada de armazenamento de dados).

Os detalhes sobre novos relatórios específicos disponíveis são os seguintes:

Documento API por Endpoint¶

Quando você expõe seu aplicativo como uma API, há um novo relatório Documento de API por Endpoint disponível que lista todas as chaves de API e usuários, bem como conexões externas (lista URLs usados para conectar-se a sistemas externos), incluindo endpoints de notificação e endpoints REST. A documentação incluída neste relatório também gera exemplos de chamadas de API e exemplos de CURL em um formato que você pode usar para copiar e colar e iniciar o teste diretamente na saída do relatório. As operações apoiadas também estão incluídas neste relatório.

Para Executar o Documento da API por Relatório de Endpoint¶

Navegue até Vinyl IDE
Clique em Ampliar sua empresa no menu Conectar
Selecione a opção do menu de navegação Publicar
Para o aplicativo para o qual você está executando um relatório, clique no ícone PDF em Doc:
As informações resultantes do Crystal Report incluem as informações descritas acima, bem como uma lista de Operações Suportadas:

Notas de Versão por Aplicativo¶

Quando você gera um lançamento no Vinyl, há um novo ícone de documento que gera um relatório Notas de lançamento por aplicativo para o pacote. O relatório Notas de versão lista todas as fontes de dados, solicitações de gerenciamento de alterações, pacotes de tradução e configuração de exportação de tabela. As informações incluídas neste relatório são derivadas de informações fornecidas à medida que você avança no Release Template Builder.

Para Executar o Relatório de Notas de Versão por Aplicativo¶

Navegue até Vinyl IDE
Clique em Implementar seu aplicativo no menu Build
Depois de configurar seu pacote de lançamento usando o modelo Release Builder, clique no ícone PDF em Doc:
O Crystal Report resultante inclui as informações descritas acima:

Relatórios de Auditoria por Camada de Vinyl – UI, Lógica de Negócios e Camadas de Armazenamento de Dados¶

Novos relatórios de auditoria estão disponíveis para todas as camadas do Vinyl – UI Layer, Business Logic Layer e Data Storage Layer. Além disso, os relatórios de funções e pontes receberam uma atualização de interface do usuário para corresponder às outras camadas de Vinyl e parecer consistentes.

Relatório de Menus e Páginas da Camada de Interface do Usuário¶

Existe um novo relatório de menus e páginas da camada de UI para fornecer um relatório imprimível da configuração do aplicativo na camada de UI. As informações do relatório incluem: Menus, um detalhamento de todas as páginas do aplicativo, incluindo informações sobre detalhes da página, painel e controles em cada página, se a página está ativa ou não e uma auditoria sobre quem foi o último usuário a fazer alterações.

Para Executar o Relatório de Menus e Páginas da Camada de UI¶

Navegue até Vinyl IDE
Clique em Construa seu aplicativo no menu Construir
Localize seu aplicativo no painel Aplicativos, na camada UI
Clique no ícone PDF em Doc:
O Crystal Report resultante inclui as informações descritas acima:

Relatórios de Lógica de Negócios¶

Na camada Business Logic, há dois novos relatórios disponíveis. O relatório Objetos e regras por tabela lista todos os objetos de negócios baseados em tabela e inclui o status. O relatório Execução de eventos por tabela fornece informações sobre eventos intrínsecos e personalizados em execução em tabelas no aplicativo.

Para Executar o Relatório de Objetos e Regras por Tabela¶

Navegue até Vinyl IDE
Clique em Construa seu aplicativo no menu Construir
Selecione Camada Lógica de Negócios no menu de navegação
Localize sua origem de dados da camada de negócios. Por exemplo: MySQL - Northwinds
Clique no ícone PDF em Doc:
O Crystal Report resultante inclui as informações descritas acima:

Para Executar o Relatório de Execução de Eventos por Tabela¶

Navegue até Vinyl IDE
Clique em Construa seu aplicativo no menu Construir
Selecione Camada Lógica de Negócios no menu de navegação
Localize sua origem de dados da camada de negócios. Por exemplo: MySQL - Northwinds
Clique no ícone de lista numerada em Documento de Execução:
O Crystal Report resultante inclui as informações descritas acima:

Relatório de Camada de Armazenamento de Dados por Tabela¶

Existe um novo relatório para o armazenamento de dados, denominado Camada de armazenamento de dados por tabela. Este relatório fornece informações sobre o esquema básico do banco de dados, por tabela. As informações no relatório incluem: configuração da tabela, restrições principais, relacionamentos principais e colunas existentes para a tabela. As informações das colunas capturadas no relatório incluem índice, nome, tipo lógico, tipo de armazenamento, uso, auditoria, geração automática e se a coluna é obrigatória.

Para Executar o Relatório Camada de Armazenamento de Dados por Tabela¶

Navegue até Vinyl IDE
Clique em Construa seu aplicativo no menu Construir
Selecione Camada de armazenamento de dados no menu de navegação
Localize sua origem de dados da camada de negócios. Por exemplo: MySQL - Northwinds
Clique no ícone PDF em Doc:
O Crystal Report resultante inclui as informações descritas acima: