CONTEÚDO

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


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

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 17/03/2022.

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

01. VISÃO GERAL

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

02. EXEMPLO DE UTILIZAÇÃO


Para listar os tipos de Cards e Gráficos customizados, basta clicar na opção 'Customizações' do menu. Esta opção de menu está disponível apenas para usuários administradores.

Ao acessar esta opção do menu, será apresentada a tela de Manutenção de Cards e Gráficos Customizados, na qual possui 2 abas: uma aba para listar e filtrar tipos de card e outra aba para listar e filtrar tipos de gráfico:

Nesta tela, serão apresentados todos os registros que estiverem com os campos A1P_CUSTOM e A1N_CUSTOM = .T.

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

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:

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).

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.

Clicar em 'Salvar':

Incluir um Card com o novo Tipo cadastrado:

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

Vincular o novo card criado à uma visão:

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

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

Clicar em 'Salvar':

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

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

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:

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);

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.

Clicar em 'Salvar':

Incluir um Gráfico com o novo Tipo cadastrado:

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

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

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

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

Clicar em 'Salvar':

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

03. TABELAS UTILIZADAS