...

       O objetivo da API de Integração de Tabelas Dinâmicas do TReports é promover uma forma de consultar e manipular tabelas dinâmicas dentro do ERP TOTVS. 

Download de Arquivo

Neste modelo iremos demonstrar com o fluxo onde é solicitado a geração de um relatório para o sistema.

É apresentado um cenário em que o relatório já esteja previamente cadastrado, e para prosseguirmos com o fluxo é necessário que tenhamos a informação do identificador do relatório.

Iniciaremos o fluxo buscando pelo identificador do relatório (id) na API de busca de relatório onde seguiremos nas etapas de busca de parâmetros, solicitação de geração finalizando na API de download do arquivo gerado.

Busca de Relatório

Busca de Tabelas Dinâmicas

...

A "busca de tabelas dinâmicas" é uma API que retorna as tabelas cadastrados no sistema. Através dessa API é possível buscar apenas as tabelas as quais o usuário possui permissão de acesso, sejam elas de sua própria criação ou que tenham sido compartilhadas com o usuário de forma única ou através de pastas.

A busca possui a funcionalidade de filtro por nome ou descrição da tabela dinâmica, A "busca de relatório" é uma API que retorna os relatórios cadastrados no sistema, é possível buscar apenas os relatórios em que o usuário tem permissão de acesso, sejam eles de sua própria criação, compartilhados via pasta ou compartilhamento único. Assim como na interface do sistema, a busca possui a funcionalidade de filtro onde é necessário enviar no mínimo 3 caracteres para pesquisa, dessa . Dessa forma, os relatórios as tabelas dinâmicas que tiverem esses caracteres em comum em seu nome de exibição ou descrição serão retornados. . Existe ainda a funcionalidade de busca através do ID de pasta. Dessa forma serão retornadas as tabelas que estejam vinculadas à pasta informada.

Detalhes da implementação são encontrados no endpoint abaixo:

Image RemovedImage Added

Abaixo temos um exemplo da lista de relatórios retornados tabelas dinâmicas retornada pela API, utilizaremos o relatório com id: a4127383-3229-420f-bd47-c795c2af5ebd como exemplo para dar continuidade em nosso fluxo de uso na próxima etapa.

[	
	    {
        "id": "a41273835de91591-322966bb-420f4615-bd479e7a-c795c2af5ebd5fe55ccb584d",
        "displayName": "Recibo de Fatura (JU203b) Pedidos Realizados",
        "description": "ReciboTabela de Fatura (JU203b) - Grupo de EstudosPedidos Realiados",
        "navigationFolderId": 1null
    },
    {
        "id": "cd767d3f2f670be2-ec71679b-4c1a401e-8143a0b6-c6645dd8f63c7f95a2ac8b28",
        "displayName": "Recibo de Fatura\"Pessoas Registradas",
        "description": "ReciboTabela de Pessoas Fatura\"Registradas",
        "navigationFolderId": null
    },
    {
        "id": "e30288af9f6977fa-69890e37-4a3043a3-9792a301-3c7f5735db5678ca1eeb040a",
        "displayName": "Relatorio sem fitro de casosProdutos",
        "description": null,
        "navigationFolderId": null
    }
]

Busca de Parâmetros 

É importante lembrar que um relatório pode conter parâmetros para sua geração, caso não tenha conhecimento da existência de parâmetros para o relatório selecionado, basta consultar a API abaixo.

Image Removed

A "busca de parâmetros" lista todos os parâmetros necessários para que o relatório posso ser executado, utilizaremos o valor do campo "name" de cada parâmetro para a próxima etapa.

[
    {
        "name": "pCodEscr"Tabela de Produtos Cadastrados",
        "displayName": "Código do Escritório",
        "type": "string",
        "multiValue": true
    },
    {
        "name": "pCodFatura",
        "displayName": "Código da Fatura",
        "type": "number",
        "multiValue": false
    },
    {
        "name": "pNomeSocio",
        "displayName": "Nome do Sócio da Fatura",
        "type": "string",
        "multiValue": false
    }
]

Solicitação de Geração de um Arquivo

O endpoint "Solicitar Geração de um Arquivo" é uma API utilizada para solicitar a geração de um arquivo para o relatório escolhido, desde o início do fluxo coletamos informações importantes para utilização deste endpoint. Utilizaremos o identificador do relatório id: a4127383-3229-420f-bd47-c795c2af5ebd e o valor da propriedade "name" de cada parâmetro necessário para geração "pCodEscr", "pCodFatura" e "pNomeSocio".

É importante destacar que alguns parâmetros podem ser Multivalorados, ou seja, podem receber mais de um valor. Este tipo de parâmetro é reconhecido quando sua propriedade "multiValue" está definida como "true".

No caso do exemplo, é possível perceber que o parâmetro "pCodEscr" é multi valorado "multiValue: true", ou seja, o parâmetro recebe uma lista de valores.

Detalhes da implementação são encontrados no endpoint abaixo:

Image Removed

Cada solicitação é exclusiva de acordo com os parâmetros necessários, neste caso serão enviados no corpo da requisição "body" os parâmetros e seus respectivos valores conforme exemplo abaixo:

{
  "pCodEscr": ["SP001", "SP002"],
  "pCodFatura": 180,
  "pNomeSocio": "Isabelle Silva"
}

Caso a requisição seja feita corretamente, será apresentado como retorno o identificador de geração "generationId"  que utilizaremos na proxima etapa.

"3b845650-3972-49ae-9b5c-32f02423782b"

Download do Arquivo

Em nossa última etapa do fluxo utilizaremos o identificador da geração "3b845650-3972-49ae-9b5c-32f02423782b"  da etapa anterior para requerer o download do arquivo. 

Detalhes da implementação são encontrados no endpoint abaixo:

Image Removed

...

Excel a partir de 2010

...

html

...

navigationFolderId": null
    }
]

Hyperlink para Integração com Viewer Externo

...

O "hyperlink para integração com viewer externo" é uma API que retorna quais são as rotas de integração por interface com as funcionalidades de tabela dinâmica. Seu objetivo é facilitar a integração com o visualizador do ERP TOTVS ou acesso diretamente pelo browser, informando qual deve ser a rota a ser acessada para exibir uma tabela dinâmica.

A API possui os parâmetros opcionais abaixo:

• pivotTableId;
• accessToken;
• expiresIn;
• tokenType;
• refreshToken;
• scope.

Caso algum parâmetro não seja informado, a API retornará um valor TEMPLATE. Caso os parâmetros sejam informados, a API retornará a rota com esses valores preenchidos

Viewer Externo

Depois que o cadastro de um relatório foi feito, para que ele seja disparado em alguma extensão do ERP TOTVS, é preciso fazer a integração para ativar a geração do mesmo, sendo assim, é preciso utilizar o hyperlink que monta os links disponíveis para integração com visualizador.
Para iniciar o fluxo precisamos ter conhecimento do id de relatório que desejamos executar, caso não saiba essa informação, utilizaremos a busca de relatório para buscar essa informação.

Busca de Relatório

A "busca de relatório" é uma API que retorna os relatórios cadastrados no sistema, é possível buscar apenas os relatórios em que o usuário tem permissão de acesso, sejam eles de sua própria criação, compartilhados via pasta ou compartilhamento único. Assim como na interface do sistema, a busca possui a funcionalidade de filtro onde é necessário enviar no mínimo 3 caracteres para pesquisa, dessa forma, os relatórios que tiverem esses caracteres em comum em seu nome de exibição ou descrição serão retornados. 

Detalhes da implementação são encontrados no endpoint abaixo:

Image RemovedImage Added

Abaixo temos um exemplo da lista de relatórios retornados hyperlink retornado pela API, utilizaremos o relatório com id: cd767d3f-ec71-4c1a-8143-c6645dd8f63c como exemplo para dar continuidade em nosso fluxo de uso na próxima etapa.sem que nenhum parâmetro tenha sido informado:

[	
	{
        "idviewer": "a4127383-3229-420f-bd47-c795c2af5ebd",
        "displayName": "Recibo de Fatura (JU203b) ",
        "description": "Recibo de Fatura (JU203b) - Grupo de Estudos",
        "navigationFolderId": 1
    },
    {
        "id": "cd767d3f-ec71-4c1a-8143-c6645dd8f63c",
        "displayName": "Recibo de Fatura\"",
        "description": "Recibo de Fatura\"",
        "navigationFolderId": null
    },
]

Hyperlinks para integração

Os links retornados na requisição de Hyperlinks são utilizados para visualização de integrações feitas com o sistema, sendo uma delas a de Visualização, dessa forma, é possível abrir o TReports utilizando todos os seus recursos em um navegador.

O endpoint que utilizaremos para esse fluxo:

Image Removed

Para utilizar essa requisição vamos precisar de um ID de um relatório existente, nesse caso, utilizaremos o ID buscado na requisição de busca: cd767d3f-ec71-4c1a-8143-c6645dd8f63c

Os demais parâmetros podem ser informados por meio de QueryString ou diretamente na URL retornada. Esses parametros são as informações do token do usuário que irá abrir a interface da integração, essas informações são utilizadas para realizar contextualização e verificação de permissões.

...

http://localhost:7017/pivot-tables/{pivotTableId}/view?access_token={accessToken}&refresh_token={refreshToken}&scope={scope}&token_type={tokenType}&expires_in={expiresIn}&hidemenus=true"
}

Image Removed