Adicionar uma nova coluna em um GRID no sistema Z-Flow

Manual prático para auxiliar os desenvolvedores para adicionar uma nova coluna em uma GRID nos sistemas Z-Flow.

O passo a passo resumido para adicionar uma nova coluna em uma GRID nos sistemas Z-Flow é:

  1. Criar um campo no Model correspondente.
  2. Alterar o formato da GRID no Controller.
  3. Verificar a consulta desta GRID para alterá-la, caso necessário.

Criando novos campos no Model

Para adicionar uma nova coluna em uma GRID nos sistemas Z-Flow, é necessário seguir os seguintes passos:

  1. Criar o(s) campo(s) com seus atributos na tabela de sua escolha.
  2. A variável correspondente é $attributes que está localizada na linha 11 do Model (arquivo TableNomeDaTabela.php) da entidade.
  3. As chaves estrangeiras devem estar na lista $primarykey, que se encontra na linha 10 do Model.
  4. O caminho e o formato para adicionar a nova coluna estão descritos no print abaixo.
  5. A ordem em que os atributos são definidos no arquivo pode influenciar a ordem em que eles são exibidos na forma visual da GRID. Portanto, é importante verificar se a ordem dos atributos está correta para garantir que a GRID seja exibida da maneira desejada.
TableCreateModelGRID.png
(Tela dos atributos de uma tabela)

É importante lembrar que a adição de uma nova coluna pode afetar outras funcionalidades do sistema, por isso é recomendado realizar testes e verificar se todos os processos continuam funcionando corretamente após a alteração.

Verificando Controller

Para encontrar a consulta realizada em uma GRID, é necessário acessar o Controller da página onde os dados são carregados. Geralmente, o Controller que deve ser acessado é o nome da tabela mais "Controller". No entanto, no caso dos processos, o Controller é o "LawsuitsTrackingAdm.php", que agrega a construção das GRIDs de processo.

No print abaixo, está localizado o trecho responsável por chamar a consulta para as fases dos processos. Na linha 160, está a chamada da consulta, na linha 162 os parâmetros de chave estrangeira e nas linhas 163 até 165 estão as colunas da GRID.

ControllerLawsuit.png
(Tela de exemplo de um Controller)

Verificando Consulta

Caso a nova coluna seja uma chave estrangeira, é necessário alterar a consulta executada no Controller correspondente. A consulta está localizada na parte final dos arquivos "TableNomeDaTabela.php". Estão agrupadas na variável $have uma lista de objetos com os seguintes atributos: "Object" (Model utilizado na consulta), "With" (Objeto com os JOINs da consulta), "When" e "order_by". No exemplo abaixo, é a consulta das fases do processo no arquivo de processo.

É importante lembrar que a alteração da consulta pode afetar outras funcionalidades do sistema, por isso é recomendado realizar testes e verificar se todos os processos continuam funcionando corretamente após a alteração.

QueryHaveTableLawsuit.png
(Parte sobre as consultas no arquivo "TableNomeDaTabela.php")