Relatórios auto-documentados no Jitterbit App Builder

Visão geral

O App Builder possui recursos auto-documentados na forma de relatórios. Áreas específicas do App Builder têm 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. A geração de relatórios para esse recurso está disponível nas seguintes áreas do App Builder: Documento da API por Endpoint, Notas de Lançamento por Aplicação, Relatórios de Auditoria por Camada do App Builder (Camada de UI, Camada de Lógica de Negócios, Camada de Armazenamento de Dados).

Os detalhes sobre novos relatórios específicos disponíveis seguem:

Documento da API por endpoint

Quando você expõe sua aplicação como uma API, há um novo relatório Documento da API por Endpoint disponível que lista todas as Chaves de API e Usuários, bem como Conexões Externas (lista URLs usadas para conectar a sistemas externos), incluindo servidores de notificação e endpoints REST. A documentação incluída neste relatório também gera chamadas de API de exemplo e um CURL de amostra em um formato que você pode usar para copiar e colar e começar a testar diretamente a partir da saída do relatório. Operações Suportadas também estão incluídas neste relatório.

Para executar o relatório documento da API por endpoint

1. Navegue até o App Builder IDE
2. Clique em Expandir sua empresa no menu Conectar
3. Selecione a opção do menu de navegação Publicar

4. Para a aplicação para a qual você está executando um relatório, clique no ícone PDF sob Doc:

   

5. As informações resultantes do Crystal Report incluem as informações descritas acima, bem como uma lista de Operações Suportadas:

   

Notas de lançamento por aplicação

Quando você gera um Lançamento no App Builder, há um novo ícone Doc que gera um relatório Notas de Lançamento por Aplicação para o pacote. O relatório de Notas de Lançamento lista todas as fontes de dados, solicitações de gerenciamento de mudanças, pacotes de tradução e configuração de exportação de tabelas. As informações incluídas neste relatório são derivadas das informações fornecidas à medida que você avança pelo Construtor de Modelos de Lançamento.

Para executar as notas de versão por relatório de aplicativo

1. Navegue até o App Builder IDE
2. Clique em Implantar seu aplicativo no menu Build

3. Após configurar seu pacote de lançamento usando o Modelo de Criador de Lançamento, clique no ícone PDF em Doc:

   

4. O relatório Crystal resultante inclui as informações descritas acima:

   

Relatórios de auditoria por camada do App Builder – Camadas de UI, lógica de negócios e armazenamento de dados

Novos relatórios de auditoria estão disponíveis para todas as camadas do App Builder – Camada de UI, Camada de Lógica de Negócios e Camada de Armazenamento de Dados. Além disso, os Relatórios de Funções e Ponte receberam uma atualização de UI para combinar com as outras Camadas do App Builder e parecer consistentes.

Relatório de menus e páginas da camada de UI

Um novo relatório de Menus e Páginas da Camada de UI existe para fornecer um relatório imprimível da configuração do aplicativo na Camada de UI. As informações do relatório incluem: Menus, uma divisão de todas as Páginas no 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

1. Navegue até o App Builder IDE
2. Clique em Construir seu aplicativo no menu Build
3. Localize seu aplicativo no painel de Aplicações, na Camada de UI

4. Clique no ícone PDF em Doc:

   

5. O relatório Crystal resultante inclui as informações descritas acima:

   

Relatórios de lógica de negócios

Na Camada de Lógica de Negócios, há dois novos relatórios disponíveis. O relatório Objetos e Regras por Tabela lista todos os objetos de negócios baseados por Tabela e inclui o Status. O relatório Execução de Eventos por Tabela fornece informações sobre Eventos intrínsecos e personalizados que estão sendo executados nas Tabelas do aplicativo.

Para executar o relatório de objetos e regras por tabela

1. Navegue até o App Builder IDE
2. Clique em Construa seu aplicativo no menu Build
3. Selecione a Camada de Lógica de Negócios no menu de navegação
4. Localize sua fonte de dados da camada de negócios. Por exemplo: MySQL - Northwinds

5. Clique no ícone PDF em Doc:

   

6. O relatório Crystal resultante inclui as informações descritas acima:

   

Para executar o relatório de execução de eventos por tabela

1. Navegue até o App Builder IDE
2. Clique em Construa seu aplicativo no menu Build
3. Selecione a Camada de Lógica de Negócios no menu de navegação
4. Localize sua fonte de dados da camada de negócios. Por exemplo: MySQL - Northwinds

5. Clique no ícone de lista numerada em Execution Doc:

   

6. O relatório Crystal resultante inclui as informações descritas acima:

   

Relatório da camada de armazenamento de dados por tabela

Um novo relatório existe para o Armazenamento de Dados, chamado 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 de chave, relacionamentos de chave e colunas que existem 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 da camada de armazenamento de dados por tabela

1. Navegue até o App Builder IDE
2. Clique em Construa seu aplicativo no menu Build
3. Selecione a Camada de Armazenamento de Dados no menu de navegação
4. Localize sua fonte de dados da camada de negócios. Por exemplo: MySQL - Northwinds

5. Clique no ícone PDF sob Doc:

   

6. O relatório Crystal resultante inclui as informações descritas acima: