Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Tabelas utilizadas


Aviso
titleImportante

Esta funcionalidade está em etapa de desenvolvimento e testes de pilotos.

Aviso
titleImportante

Esta funcionalidade está disponível a partir do release 12.1.33 (Expedição contínua com data >= à 24/06/2022).

Nota
titleATENÇÃO: Pacotes necessários para o funcionamento da rotina

Para o funcionamento desta rotina, foi necessária a criação de dois campos e um índice:

  • Campos A1P_CUSTOM e A1N_CUSTOM;
  • Índice 2 para a tabela A1Q.

Portanto, deve-se aplicar o pacote da expedição contínua do Faturamento ou do Backoffice Protheus superior ou igual a data de corte XX17/XX/XXXX (Informar link)03/2022.

Mais informações podem ser obtidas nas documentações DT API Tipos de Cards e Gráficos CustomizadosDT Validação na exclusão de Tipos de Cards e Gráficos Customizados.

Âncora
VISAO_GERAL
VISAO_GERAL

01. VISÃO GERAL

O menu Customizações (Manutenção de Cards e Gráficos Customizados) permite Incluir, Editar Excluir tipos de gráficos e cards customizados.

Âncora
EXEMPLO_UTILIZACAO
EXEMPLO_UTILIZACAO

02. EXEMPLO DE UTILIZAÇÃO

...

Expandir
titleManutenção de Tipos de Card Customizados

Na manutenção de Tipos de Card Customizados, são disponibilizadas três opções: Incluir, Alterar e Excluir:

Expandir
titleIncluir

Na inclusão de um tipo de card customizado, ele é inserido na base de dados informando o campo A1N_CUSTOM = .T., campo que indica quando um dado é customizado ou não. Segue abaixo o processo de inclusão:

Totvs custom tabs box
tabsPasso 1, Passo 2, Passo 3, Passo 4, Passo 5
idspasso1,passo2,passo3,passo4,passo5
Totvs custom tabs box items
defaultyes
referenciapasso1

Clicar na opção Incluir, informar o título para o card e selecionar a opção de 'Tipo' como 'Card':

Ao selecionar a opção de 'Tipo' como 'Card', um formulário é aberto solicitando os quatro endpoints necessários para o funcionamento de um Card. Para entender detalhadamente cada um deles, consultar documentação CoreDash - Criação de novos Cards e Gráficos, tópico EXEMPLO DE UTILIZAÇÃO.

URI Serviço do Card: Serviço que retorna as informações que poderão ser apresentadas no card (Correspondente ao endpoint cardInfo do exemplo citado acima);

URI Serviço de Campos: Serviço que retorna a propriedade e o nome dos campos que poderão ser apresentados no card (Correspondente ao endpoint fieldsInfo do exemplo citado acima);

URI Serviço de Itens: Serviço que retorna as informações que serão apresentadas na opção 'Detalhes' do card (Correspondente ao endpoint itemsDetails do exemplo citado acima);

URI Serviço de Filtro: Serviço que retorna os campos que poderão ser utilizados no filtro do card (Correspondente ao endpoint cardFilter do exemplo citado acima).

Totvs custom tabs box items
defaultno
referenciapasso2

Preencher o formulário informando os endpoints e clicar em 'Validar':

O botão 'Validar' será liberado apenas quando todos os campos forem preenchidos. Sua função é validar se todos os endpoints retornam a estrutura necessária, conforme documento CoreDash - Criação de novos Cards e Gráficos, tópico EXEMPLO DE UTILIZAÇÃO (Retorno esperado para esse endpoint). Caso algum dos serviços informados não retorne a estrutura correta, o botão de 'Salvar' não será liberado e será retornada a mensagem de erro para cada endpoint que falhou.

Totvs custom tabs box items
defaultno
referenciapasso3

Clicar em 'Salvar':

Totvs custom tabs box items
defaultno
referenciapasso4

Incluir um Card com o novo Tipo cadastrado:

  1. Clicar em Cards;
  2. Incluir Card conforme documentação Gerenciar Cards.

Totvs custom tabs box items
defaultno
referenciapasso5

Vincular o novo card criado à uma visão:

Expandir
titleAlterar
Totvs custom tabs box
tabsPasso 1, Passo 2, Passo 3
idspasso6,passo7,passo8
Totvs custom tabs box items
defaultyes
referenciapasso6

Posicionar no item que deseja alterar e clicar no ícone de lápis:

Totvs custom tabs box items
defaultno
referenciapasso7

Alterar o que for necessário e clicar em 'Validar':

Totvs custom tabs box items
defaultno
referenciapasso8

Clicar em 'Salvar':

Expandir
titleExcluir

Posicionar no item que deseja alterar excluir e clicar no ícone de lixeira:

Expandir
titleManutenção de Gráficos Tipos de Gráfico Customizados

Na manutenção de Tipos de Gráfico Customizados, são disponibilizadas três opções: Incluir, Alterar e Excluir:

Expandir
titleIncluir

Na inclusão de um tipo de gráfico customizado, ele é inserido na base de dados informando o campo A1P_CUSTOM = .T., campo que indica quando um dado é customizado ou não. Segue abaixo o processo de inclusão:

Totvs custom tabs box
tabsPasso 1, Passo 2, Passo 3, Passo 4, Passo 5
idspasso10,passo11,passo12,passo13,passo14
Totvs custom tabs box items
defaultyes
referenciapasso10

Clicar na opção Incluir, informar o título para o gráfico e selecionar a opção de 'Tipo' como 'Gráfico':

Ao selecionar a opção de 'Tipo' como 'Gráfico', um formulário é aberto solicitando os três endpoints necessários para o funcionamento de um Gráfico. Para entender detalhadamente cada um deles, consultar documentação CoreDash - Criação de novos Cards e Gráficos, tópico EXEMPLO DE UTILIZAÇÃO.

URI Serviço do Formulário: Serviço que retorna o formulário para cadastro do gráfico (Correspondente ao endpoint form do exemplo citado acima);

URI Serviço de Dados: Serviço que retorna os dados que serão apresentados no gráfico (Correspondente ao endpoint retdados do exemplo citado acima);

URI Serviço de Itens: Serviço que retorna as informações que serão apresentadas na opção 'Detalhes' do gráfico (Correspondente ao endpoint itemsDetails do exemplo citado acima);

Totvs custom tabs box items
defaultno
referenciapasso11

Preencher o formulário informando os endpoints e clicar em 'Validar':

O botão 'Validar' será liberado apenas quando todos os campos forem preenchidos. Sua função é validar se todos os endpoints retornam a estrutura necessária, conforme documento CoreDash - Criação de novos Cards e Gráficos, tópico EXEMPLO DE UTILIZAÇÃO (Retorno esperado para esse endpoint). Caso algum dos serviços informados não retorne a estrutura correta, o botão de 'Salvar' não será liberado e será retornada a mensagem de erro para cada endpoint que falhou.

Totvs custom tabs box items
defaultno
referenciapasso12

Clicar em 'Salvar':

Totvs custom tabs box items
defaultno
referenciapasso13

Incluir um Gráfico com o novo Tipo cadastrado:

  1. Clicar em Gráficos;
  2. Incluir Gráfico conforme documentação Gerenciar Gráficos.

Totvs custom tabs box items
defaultno
referenciapasso14

Vincular o novo gráfico criado à uma visão:

Expandir
titleAlterar
Totvs custom tabs box
tabsPasso 1, Passo 2, Passo 3
idspasso6passo15,passo7passo16,passo8passo17
Totvs custom tabs box items
defaultyes
referenciapasso6passo15

Posicionar no item que deseja alterar e clicar no ícone de lápis:

Image RemovedImage Added

Totvs custom tabs box items
defaultno
referenciapasso7passo16

Alterar o que for necessário e clicar em 'Validar':

Image RemovedImage Added

Totvs custom tabs box items
defaultno
referenciapasso8passo17

Clicar em 'Salvar':

Image Added

Expandir
titleExcluir

Posicionar no item que deseja excluir e clicar no ícone de lixeira:

Image Removed

Image Added

Âncora
TABELAS
TABELAS

03. TABELAS UTILIZADAS

...