Índice
Índice |
---|
exclude | .*ndice |
---|
printable | false |
---|
|
Objetivo
O objetivo da API de Importação de Recursos do TReports é promover uma forma de importar recursos existentes através ERP TOTVS. Com isso, o ERP TOTVS pode injetar no TReports um conjunto de recursos padrões, como por exemplo relatórios administrativos e financeiros.
Informações |
---|
|
A API pública de Importação está disponível em qualquer instalação do TReports a partir da versão 1.8.X (revisar na liberação) e suas operações estão documentadas via Swagger. |
API
A Importação é uma API que recebe um arquivo ZIP contendo os recursos exportados no TReports, realiza a importação na instância atual e retorna as informações dos recursos importados. É possível também realizar a importação de um arquivo único de um recurso (ver limitação abaixo).
Atualmente a API suporta a importação dos tipos de recurso abaixo:
- Relatórios;
- Tabelas Dinâmicas;
- Visões de Dados;
O formato de retorno da API para as informações dos recursos importados é:
- {fileName}: Nome do arquivo do recurso importado contido no arquivo ZIP enviado*
- {resourceType}: Tipo do recurso importado
- Valores possíveis
- "report": relatórios;
- pivot-table: tabelas Dinâmicas;
- data-grid: Para as Visões de Dados;
- {resourceId}: Id do recurso importado na instância atual do TReports
*Obs: Caso seja enviado um arquivo simples contendo um recurso, o campo fileName ira retornar como null.
Detalhes da implementação são encontrados no endpoint abaixo:
![](/download/attachments/709409831/image2022-9-16_17-35-41.png?version=1&modificationDate=1663360624267&api=v2)
Exemplo de uso da API
Abaixo será exemplificando um caso em que que o ERP necessita importar no TReports alguns recursos previamente desenvolvidos.
Considerando que previamente foram criados e exportados no Treports os recursos abaixo:
Relatórios
- Relatório de Banco de Horas;
- Relatório de Depreciação;
Tabelas Dinâmicas
- Total de Funcionários;
- Média de Vendas;
Visões de Dados
- Vendas por filial
- Funcionários por departamento
Os nomes dos arquivos exportados desses recursos foram editados e incluídos em um arquivo ZIP de nome "Recursos ERP" conforme figura abaixo:
![](/download/attachments/709409831/image2022-9-16_18-27-5.png?version=1&modificationDate=1663363625127&api=v2)
Obs.: Não é necessário que os arquivos simples dos recursos tenham a extensão ".treports". Essa extensão é utilizada apenas para identificar o tipo do recurso.
Ao enviar o arquivo ZIP contendo os arquivos acima via API de importação, será retornada as seguintes informações:
Bloco de código |
---|
|
[
{
"fileName": "Funcionarios por departamento.treports",
"resourceType": "data-grid",
"resourceId": "922b0080-c30c-4972-a174-cff5e3ef2bf3"
},
{
"fileName": "Media de Vendas.treports",
"resourceType": "pivot-table",
"resourceId": "c5befab1-1d7f-47b5-880c-8f76c91ab8c0"
},
{
"fileName": "Relatorio de Banco de Horas.treports",
"resourceType": "report",
"resourceId": "27f87e71-e0ab-453a-9f3a-52623075f06c"
},
{
"fileName": "Relatorio de Depreciacao.treports",
"resourceType": "report",
"resourceId": "94032928-1aad-4336-ab0d-ec7836819307"
},
{
"fileName": "Total de Funcionarios.treports",
"resourceType": "pivot-table",
"resourceId": "b48f25a5-8f1f-42b5-83ea-d106b9dd28df"
},
{
"fileName": "Vendas por filial.treports",
"resourceType": "data-grid",
"resourceId": "7eeff9bb-0c73-447e-8f90-4307d7c712e1"
}
] |
De posse do ID dos recursos, é possível realizar as consultas através das APIs públicas de cada um.
É importante destacar que os recursos importados estarão disponíveis apenas para o usuário utilizado na chamada à API.
Para que outros usuários ou grupos de usuários tenham acesso aos recursos importados, é necessário que seja feito o compartilhamento, conforme detalhado na página Compartilhamento de Recursos com ERP TOTVS.