Mudanças entre as edições de "Cadastros"

(→‎Conclusão)
Linha 1: Linha 1:
 
==='''Conceito'''===
 
==='''Conceito'''===
−
Para cada tela do sistema, temos um registro de cadastro com as informações necessárias para criação do layout e o engenho de controle dos registros. O cadastro ainda prevê configurações de segurança e especifica as classes de negócio que serão utilizadas na interface e no servidor de aplicação.
 
  
−
Em cada cadastro é informada a [[Tabelas|tabela]] do banco de dados correspondente, como por exemplo no cadastro de clientes, é utilizada a tabela PESSOAS. A partir da tabela, o sistema identifica os campos e cria em tempo de execução a estrutura necessária para o usuário manipular os registros da tabela. Para garantir a integridade das informações e otimizar o cadastramento, o cadastro disponibiliza por padrão alguns recursos como por exemplo:
+
O cadastro de Cadastros é responsável por definir como as telas do PHERP serão construídas e como os registros serão manipulados pelo sistema. Nele são configuradas as informações necessárias para criação dinâmica das telas, definição da tabela utilizada, páginas, campos, botões, regras de negócio, permissões e demais recursos utilizados durante a execução do sistema.
−
:*Na criação de um novo registro, e as colunas com informações pré-definidas, são preenchidas automaticamente, além de controle internos como a geração de chave do registro.
 
−
:*Quando cliente possui alguma regra de negócio implementada no script da tabela relacionada ao cadastro, também são executados procedimentos correspondentes, como por exemplo o preenchimento automático de informações definidas pela cliente.
 
−
:*Ao realizar a gravação do registro, o cadastro realiza validação dos campos definidos como obrigatórios, assim como também a chamada do engenho de script para tratamento de regras de negócio do cliente.  
 
  
−
No cadastro de registros relacionados, como por exemplo documento e itens do documento, são utilizados "sub-cadastros" que serão relacionados automaticamente para o respectivo usuário.
+
Para cada tela do sistema existe um registro de cadastro contendo as informações necessárias para criação do layout e do mecanismo de controle dos registros. O cadastro também prevê configurações de segurança e especifica as classes de negócio utilizadas tanto na interface do usuário quanto no servidor de aplicação.
 +
 
 +
Em cada cadastro é informada a [[Tabelas|tabela]] correspondente no banco de dados. Como exemplo, o cadastro de Clientes utiliza a tabela '''PESSOAS'''. A partir dessa tabela, o sistema identifica os campos disponíveis e cria, em tempo de execução, toda a estrutura necessária para manipulação dos registros.
 +
 
 +
Além disso, o cadastro disponibiliza diversos recursos que garantem a integridade das informações e automatizam parte dos processos, como:
 +
 
 +
* Preenchimento automático de campos previamente configurados durante a inclusão de novos registros, incluindo controles internos como a geração da chave primária.
 +
* Execução automática das regras de negócio implementadas nos scripts da tabela, como preenchimento de informações, validações e demais procedimentos personalizados.
 +
* Validação dos campos obrigatórios durante a gravação do registro, além da execução do mecanismo de scripts responsável pelas regras de negócio.
 +
 
 +
Nos cadastros que possuem registros relacionados, como por exemplo Documentos e Itens do Documento, são utilizados sub-cadastros, permitindo que os relacionamentos entre as informações sejam gerenciados automaticamente pelo sistema.
 +
 
 +
----
 +
 
 +
==='''Funcionamento'''===
 +
 
 +
O cadastro utiliza a estrutura definida na [[Tabelas|tabela]] relacionada para construir dinamicamente a interface de usuário. A partir dessa configuração, o sistema identifica os campos disponíveis, organiza-os em páginas, aplica regras de segurança, executa scripts e disponibiliza todos os recursos necessários para manipulação dos registros.
 +
 
 +
Dessa forma, alterações realizadas na configuração do cadastro passam a refletir diretamente no comportamento da tela correspondente, reduzindo a necessidade de alterações no código da aplicação.
 +
 
 +
----
  
 
==='''Registro do Cadastro'''===
 
==='''Registro do Cadastro'''===
  
−
*'''Nome:''' Corresponde a identificação do cadastro e não pode contar caracteres especiais ou espaços. Após a gravação o nome não poderá mais ser alterado, pois torna-se a chave de uso do sistema. Quando houver a criação de cadastros por parte do cliente, o nome será acrescido de "C_" no início do nome, assim fica garantido que não haverá conflito com cadastro de sistema.
+
===='''Configurações Gerais'''====
−
*'''Legenda''' Título do cadastro que será exibido para usuário na parte superior da tela.
+
 
−
*'''Tabela:''' São as [[Tabelas]] do banco de dados relacionada ao cadastro.
+
* '''Nome:''' Corresponde à identificação única do cadastro e não pode conter caracteres especiais ou espaços. Após a gravação, o nome não poderá mais ser alterado, pois passa a ser a chave de identificação do cadastro. Nos cadastros personalizados pelo cliente, o sistema acrescenta automaticamente o prefixo '''C_''', evitando conflitos com cadastros nativos.
−
*'''Sem Vinculo:''' Disponível somente nos sub-cadastros. Quando desmarcado, determina se no campo "Parente" a seguir será informado para sistema gerenciar a relação entre o cadastro pai e cadastro filho. Quando marcado serão exibidos todos os registros do cadastro, e pode-se utilizar o campo "Filtro", para determinar expressões SQL para filtrar dos registros.
+
 
−
*'''Parente:''' Disponível somente nos sub-cadastros. Será exibido para seleção os campos relacionados a tabela pai daquele respectivo cadastro em questão, como por exemplo: Considerando que temos o cadastro DOCUMENTOS, e o sub-cadastro ITENS, na lista de campos parente do cadastro ITENS, será exibido campo DOCUMENTO.
+
* '''Legenda:''' Título apresentado ao usuário na parte superior da tela.
−
*'''Sequência:''' Sub-cadastros, por padrão são exibidos em páginas ao final do cadastro pai, a sequência determina a ordem de exibição quando houver mais de um sub-cadastro. Quando o sub-cadastro estiver parametrizado para exibição em outro ponto da tela, não será exibido ao final.
+
 
−
*'''Classe no Cliente:''' Classe de negócio da aplicação de cliente desktop windows 32, ou 64 bits.
+
* '''Tabela:''' [[Tabelas|Tabela]] do banco de dados utilizada pelo cadastro.
−
*'''Classe no Servidor:''' Classe de negócio utilizada junto ao servidor de aplicação.
+
 
−
*'''Tipo:''' Determina o tipo de layout que será adotado na criação da tela de cadastro.
+
* '''Sem Vínculo:''' Disponível apenas para sub-cadastros. Quando desmarcado, o sistema exige a configuração do campo '''Parente''' para controlar automaticamente o relacionamento entre cadastro pai e cadastro filho. Quando marcado, todos os registros da tabela poderão ser exibidos, podendo ser utilizados filtros SQL para restringir sua visualização.
−
**'''Grid:''' No tipo grid, a tela será construída com grid principal para seleção e filtro dos registros.  
+
 
−
***'''Tamanho Grid:''' Tamanho do grid em pixels.
+
* '''Parente:''' Disponível apenas para sub-cadastros. Define o campo responsável pelo relacionamento entre o cadastro pai e o cadastro filho.
−
***'''Tipo de Exibição Grid:''' Permite definir se o grid será exibido a esquerda da tela, a direita ou de forma maximizada. Quando maximizado o cadastro será exibido com duplo click, e para retornar ao grid na parte superior do cadastro estará disponível botão para retornar.
+
 
−
***'''Exibir Grupo:''' Será exibido por padrão na parte superior do grid espaço para realizar o agrupamento de colunas. Essa opção também está disponível para o usuário quando realizado click com botão direito do mouse no cabeçalho de qualquer coluna do grid, depois agrupar por caixa.  
+
* '''Sequência:''' Define a ordem de exibição dos sub-cadastros quando houver mais de um relacionado ao cadastro principal.
−
***'''Vazio:''' Quando marcado, o cadastro não vai apresentar registros por padrão, será necessário clicar no filtro ou utilizar tecla de atalho F3. Recomentado marcar para os cadastros que possam conter muitos registros.
+
 
−
***'''Auto Exibir:''' Quando marcado, após a gravação do registro será retornado para o grid automaticamente.
+
* '''Classe no Cliente:''' Classe de negócio utilizada pela aplicação Desktop.
−
***'''Mult Select:''' Permite realizar seleção de mais de um registro no grid.
+
 
−
***'''Ajustar Colunas:''' Quando marcado as colunas do grid serão ajustadas automaticamente dentro da tela.
+
* '''Classe no Servidor:''' Classe de negócio utilizada pelo servidor de aplicação.
−
**'''Estrutura:''' Cadastro estruturado em níveis de acordo com a configuração da mascara. Similar a estrutura de um plano contábil.
+
 
−
***'''Registro Pai:''' Campo correspondente ao campo com o ID do registro pai.
+
----
−
***'''Mascara:''' Mascara da estrutura de dados. Exemplo: 9.99.999.
+
 
−
***'''Estrutura:''' Campo correspondente a estrutura. Esperado campo do tipo string, onde será gerado pelo sistema a estrutura de cada registro. Exemplo 1.01 ou 1.01.001.
+
===='''Tipo de Cadastro'''====
−
***'''Código Estrutura:''' Campo correspondente ao código do registro no nível definido na mascara. Exemplo, 1, 01 ou 001.
+
 
−
***'''Tamanho Grid:''' Tamanho em pixels do grid com os registros estruturados conforme a mascara.
+
Determina o layout utilizado para construção da tela.
−
**'''Um a Um:''' Neste tipo de cadastro, é realizada criação da tela sem o uso do grid. Para selecionar o registro a ser exibido, deverá ser parametrizado filtro junto ao cadastro ou fixo a frente.
+
 
−
**'''Um Registro:''' Cadastro com apenas um registro, sendo possível apenas informar os dados e gravar. O exemplo de uso mais comum é para as telas com parâmetros.
+
====='''Grid'''=====
−
*'''Maximizar:''' Informar sim para que o cadastro seja exibido de forma maximizada e considerar o tamanho da tela principal. Quando informado não será necessário definir a altura e largura do cadastro.
+
 
−
*'''Data / Hora:''' Preenchimento automático com a data e hora de alteração ou inclusão do cadastro.
+
Constrói a tela utilizando um grid para pesquisa, seleção e edição dos registros.
−
*'''Pré-Criar:''' Algumas partes do cadastro são criadas somente quando houver interação do usuário. Quando esta opção estiver marcada, o cadastro será criado por completo.
+
 
−
*'''Icone:''' Lista de imagens disponíveis no sistema que será exibida no título do cadastro. Recomentada utilizar o mesmo ícone utilizado no atalho que realizará a chamada do cadastro. Existem ainda uma opção de icone, baseada no cadastro de imagens personalizadas do usuário.
+
* '''Tamanho Grid:''' Define a largura do grid em pixels.
−
*'''Segmento:''' Para uso do sistema em casos onde o cadastro for de uso exclusivo de um segmento. Dessa forma, os clientes que não possuem o segmento em sua licença, não farão uso do cadastro.  
+
* '''Tipo de Exibição Grid:''' Permite exibir o grid à esquerda, à direita ou maximizado.
−
*'''Ajuda (link Wiki):''' Endereço da página com a documentação relacionada ao cadastro. Quando informado, será criado automaticamente o botão de ajuda, com link para o endereço informado.
+
* '''Exibir Grupo:''' Exibe a área de agrupamento de colunas no grid.
−
*'''É Sistema:''' Indica que o cadastro é padrão de sistema e não poderá ser alterado. Mesmo sendo de sistema é possível incluir novas páginas, ou adicionar campos as páginas.
+
* '''Vazio:''' Quando marcado, nenhum registro será carregado automaticamente, sendo necessária uma pesquisa para exibição dos dados. Recomenda-se esta opção para tabelas com grande volume de registros.
−
*'''Segurança'''
+
* '''Auto Exibir:''' Após gravar um registro, retorna automaticamente para o grid.
−
**'''Alterar:''' Permitir alteração realizar alterações.
+
* '''Mult Select:''' Permite selecionar vários registros simultaneamente.
−
**'''Incluir:''' Permitir inclusão de novos registros.
+
* '''Ajustar Colunas:''' Ajusta automaticamente a largura das colunas do grid.
−
**'''Excluir:''' Permite a exclusão de registros.
+
 
−
**'''Condição de Editabilidade:''' Informar a condição na qual o registro poderá ser editado quando a condição for verdadeira. Exemplo: SITUACAO = '1'.
+
====='''Estrutura'''=====
−
**'''Auto Leitura:''' Quando marcado em sub-cadastros, o estado de leitura do cadastro é alterado automaticamente conforme o cadastro pai.
+
 
−
**'''Permite Script:''' Permite o uso da opção de script para customizações.
+
Utilizado em cadastros hierárquicos, semelhantes a planos de contas ou árvores de classificação.
−
**'''Visualizar Informações de Registro:''' Quando marcado, está disponível na barra de ferramentas superior do cadastro, atalho para consulta [[Informações_de_Registros|informações de registros]].
+
 
 +
* '''Registro Pai:''' Campo correspondente ao registro pai.
 +
* '''Máscara:''' Estrutura utilizada para formação da hierarquia. Exemplo: 9.99.999.
 +
* '''Estrutura:''' Campo que armazenará a estrutura completa gerada pelo sistema.
 +
* '''Código Estrutura:''' Campo responsável pelo código individual de cada nível.
 +
* '''Tamanho Grid:''' Define a largura do grid.
 +
 
 +
====='''Um a Um'''=====
 +
 
 +
Constrói a tela sem utilização de grid, exibindo apenas um registro por vez.
 +
 
 +
====='''Um Registro'''=====
 +
 
 +
Utilizado para cadastros que possuem apenas um registro, como parâmetros e configurações gerais do sistema.
 +
 
 +
----
 +
 
 +
===='''Demais Configurações'''====
 +
 
 +
* '''Maximizar:''' Exibe o cadastro ocupando toda a área disponível da aplicação.
 +
 
 +
* '''Data / Hora:''' Preenchimento automático da data e hora da última alteração.
 +
 
 +
* '''Pré-Criar:''' Realiza previamente toda a criação da estrutura do cadastro.
 +
 
 +
* '''Ícone:''' Ícone utilizado no título da tela.
 +
 
 +
* '''Segmento:''' Restringe a utilização do cadastro aos clientes que possuam o segmento correspondente em sua licença.
 +
 
 +
* '''Ajuda (Link Wiki):''' Endereço da documentação correspondente na Wiki. Quando informado, o sistema disponibiliza automaticamente o botão de ajuda.
 +
 
 +
* '''É Sistema:''' Indica que o cadastro pertence ao sistema padrão e não pode ser alterado diretamente.
 +
 
 +
----
 +
 
 +
===='''Segurança'''====
 +
 
 +
Define as permissões e comportamentos relacionados à manipulação dos registros.
 +
 
 +
* '''Alterar:''' Permite alteração dos registros.
 +
 
 +
* '''Incluir:''' Permite inclusão de novos registros.
 +
 
 +
* '''Excluir:''' Permite exclusão de registros.
 +
 
 +
* '''Condição de Editabilidade:''' Expressão SQL utilizada para determinar quando um registro poderá ser editado.
 +
 
 +
* '''Auto Leitura:''' Nos sub-cadastros, acompanha automaticamente o estado de leitura do cadastro pai.
 +
 
 +
* '''Permite Script:''' Habilita a utilização de scripts personalizados.
 +
 
 +
* '''Visualizar Informações de Registro:''' Disponibiliza o atalho para consulta das [[Informações_de_Registros|Informações de Registros]].
 +
 
 +
----
  
 
===='''Páginas'''====
 
===='''Páginas'''====
−
*'''Posição das Páginas:''' Determina a posição que serão exibidas as paginas cadastro, sendo a esquerda, direita, superior, inferior ou nenhuma.
+
 
−
*'''Rotação:''' Por padrão o título página é exibido na horizontal na parte superior e inferior, e na vertical a direita ou esquerda, quando marcada rotação, o titulo é exibido com configurações horizontal ou vertical trocadas.
+
As páginas permitem organizar os campos do cadastro em abas, facilitando a navegação e melhorando a organização das informações.
−
*'''Largura Tab:''' Largura do título da página. Por padrão cada página assume o tamanho da legenda, quando determinada largura, todas as páginas assumem o mesmo tamanho, independentemente da legenda.
+
 
−
*'''Páginas:''' Cadastro de páginas do cadastro, onde a cada página poderá ser definido os campos que serão exibidos.
+
* '''Posição das Páginas:''' Define onde as abas serão exibidas.
−
**'''Sequência:''' Campo numérico que indica a sequência que será exibida a página do cadastro.
+
 
−
**'''Nome:''' Identificação única da página, podendo ser apenas letras maiúsculas e não permitido uso de caracteres especiais. Após a gravação não é possível alterar.
+
* '''Rotação:''' Altera a orientação do título das páginas.
−
**'''Legenda:''' Identificação do título da página que será exibido para o usuário.
+
 
−
**'''Segmento:''' Para uso do sistema em casos onde a página for de uso exclusivo de um segmento. Dessa forma, os clientes que não possuem o segmento em sua licença, não farão uso da página.
+
* '''Largura Tab:''' Define uma largura fixa para todas as abas.
−
**'''Margens:''' Será criado automaticamente um espaço ao redor da página, onde são criados os campos.
+
 
−
**'''É Sistema:''' Indica que a página é padrão de sistema e não poderá ser alterada. Mesmo sendo de sistema é possível incluir novos campos na página.  
+
* '''Páginas:''' Relação das páginas pertencentes ao cadastro.
−
**'''Data / Hora:''' Preenchimento automático com a data e hora de alteração ou inclusão da página.
+
 
−
**'''Botão Campos:''' Será exibida tela para cadastro do campos que serão exibidos na página. Além dos campos as demais colunas opcionais, quando informadas, serão consideradas ao invés das informações do cadastro do campo. Exemplo: Quando informado no campo da página a "Legenda", a legenda que consta no cadastro do campo será ignorada.
+
** '''Sequência:''' Ordem de exibição.
 +
 
 +
** '''Nome:''' Identificador único da página.
 +
 
 +
** '''Legenda:''' Nome apresentado ao usuário.
 +
 
 +
** '''Segmento:''' Restringe a utilização da página por segmento.
 +
 
 +
** '''Margens:''' Cria automaticamente um espaçamento interno na página.
 +
 
 +
** '''É Sistema:''' Indica que a página pertence ao sistema.
 +
 
 +
** '''Data / Hora:''' Data e hora da última alteração.
 +
 
 +
** '''Botão Campos:''' Permite configurar os campos exibidos na página e personalizar suas propriedades.
 +
 
 +
----
  
 
===='''Botões do Cadastro'''====
 
===='''Botões do Cadastro'''====
−
Cadastro de botões que serão exibidos na parte superior do cadastro, após os botões padrões do sistema para o cadastro.
 
  
−
*'''Sequência:''' Determina a sequencia de exibição do botão na barra superior.
+
Permite criar botões personalizados que serão exibidos na barra superior da tela.
−
*'''Nome:''' Nome de interno do botão. Não permite caracteres especiais ou acentuação.
+
 
−
*'''Legenda:''' Texto que será utilizado como legenda para identificação do usuário.
+
* '''Sequência'''
−
*'''Icone:''' Imagem que será utilizada no botão.
+
* '''Nome'''
−
*'''Atalho:''' Tecla de atalho. Exemplo CTRL+O ou F7.
+
* '''Legenda'''
−
*'''Sub-Menu Pai:''' Quando informado, o botão será exibido como opção de menu a partir do botão informado aqui.
+
* '''Ícone'''
−
*'''Condição de Editabilidade:''' Informar expressão SQL que quando verdadeira o botões permanecerá habilitado. Exemplo: CAMPO > 0 AND SITUACAO = '2'.
+
* '''Atalho'''
−
*'''Condição de Visibilidade:''' Informar expressão SQL que quando verdadeira o botões permanecerá visível. Exemplo: SITUACAO = '1'.
+
* '''Submenu Pai'''
−
*'''Descrição:''' Quando informada descrição com orientações, o texto será exibido na barra inferior do sistema quando o cursor estiver posicionado sobre o botão.
+
* '''Condição de Editabilidade'''
−
*'''Exibir Legenda:''' Quando marcado será exibida legenda do do botão.
+
* '''Condição de Visibilidade'''
−
*'''Segmento:''' Campo opcional para determinar o segmentos que o botão estará disponível.
+
* '''Descrição'''
−
*'''Grupo:''' Quando marcado, uma linha na lateral esquerda do botão será exibida.
+
* '''Exibir Legenda'''
−
*'''Tipo de Execução:''' Determina o tipo de execução realizada ao clicar no botão.
+
* '''Segmento'''
−
**'''Padrão:'''  
+
* '''Grupo'''
−
***'''Procedimento:''' Permite a configuração do procedimento que será acionado junto ao servidor de aplicação.
+
 
−
***'''Script:''' Permite informar um script que irá executar após o procedimento do servidor.
+
====='''Tipo de Execução'''=====
−
***'''Mensagem Confirmação:''' Mensagem que será exibida na tela para o usuário como pergunta, o usuário poderá responder com Sim ou Não.
+
 
−
***'''Transação Automática:''' Quando essa flag está marcada ao clica no botão o sistema inicia de maneira automática uma transação.
+
* '''Padrão:''' Executa procedimentos e scripts do servidor.
−
**'''Cadastro:''' Permite selecionar um dos cadastro filtros relacionados ao cadastro do botão, e realiza a exibição quando o botão for acionado.  
+
 
−
**'''Formulário:''' Permite informar um formulário, e o procedimento e script que serão executados junto ao servidor de aplicação, quando houver a confirmação no formulário.  
+
** Procedimento
−
**'''Impressão:''' Permite definir um ou mais formatos de impressão. Essa opção considera para a variável <filtro> do relatório, o ID do registro posicionado.
+
 
−
**'''E-mail:''' Permite definir um ou mais formatos de impressão para envio por e-mail. Essa opção considera para a variável <filtro> do relatório, o ID do registro posicionado. Quando acionado o botão, será exibida tela de envio de e-mails.
+
** Script
−
*'''Data / Hora:''' Data e hora que o registro foi incluído ou alterado.
+
 
 +
** Mensagem de Confirmação
 +
 
 +
** Transação Automática
 +
 
 +
* '''Cadastro:''' Abre outro cadastro relacionado.
 +
 
 +
* '''Formulário:''' Executa um formulário personalizado.
 +
 
 +
* '''Impressão:''' Executa formatos de impressão.
 +
 
 +
* '''E-mail:''' Executa formatos de impressão para envio por e-mail.
 +
 
 +
* '''Data / Hora:''' Data da última alteração.
 +
 
 +
----
  
 
===='''Filtros'''====
 
===='''Filtros'''====
−
*'''Filtro:'''
+
 
−
*'''Estilo do Filtro:'''
+
Permite configurar filtros padrões utilizados pelo cadastro.
−
*'''Filtro SQL:'''
+
 
 +
* '''Filtro:''' Define o cadastro de filtro utilizado.
 +
 
 +
* '''Estilo do Filtro:''' Determina a forma de apresentação do filtro para o usuário.
 +
 
 +
* '''Filtro SQL:''' Permite informar uma expressão SQL utilizada para restringir os registros apresentados pelo cadastro.
  
 
----
 
----
−
 
  
 
==='''Conclusão'''===
 
==='''Conclusão'''===
Linha 107: Linha 210:
 
Por meio dele é possível configurar a tabela utilizada, organizar os campos em páginas, criar botões personalizados, definir regras de segurança, condições de editabilidade e demais recursos necessários para a construção dinâmica dos cadastros.
 
Por meio dele é possível configurar a tabela utilizada, organizar os campos em páginas, criar botões personalizados, definir regras de segurança, condições de editabilidade e demais recursos necessários para a construção dinâmica dos cadastros.
  
−
Sua utilização proporciona maior flexibilidade ao sistema, permitindo centralizar configurações e facilitar a manutenção e evolução das funcionalidades do ERP.
+
Sua utilização proporciona maior flexibilidade ao sistema, permitindo centralizar configurações e facilitar a manutenção, personalização e evolução das funcionalidades do ERP.
  
 
----
 
----
  
 +
'''Assuntos Relacionados'''
  
−
'''Assuntos Relacionados'''
+
[[Tabelas]]
  
 
[[Condição de Editabilidade]]
 
[[Condição de Editabilidade]]
 +
 +
[[Informações_de_Registros]]

Edição das 09h01min de 29 de julho de 2026

Conceito

O cadastro de Cadastros é responsável por definir como as telas do PHERP serão construídas e como os registros serão manipulados pelo sistema. Nele são configuradas as informações necessárias para criação dinâmica das telas, definição da tabela utilizada, páginas, campos, botões, regras de negócio, permissões e demais recursos utilizados durante a execução do sistema.

Para cada tela do sistema existe um registro de cadastro contendo as informações necessárias para criação do layout e do mecanismo de controle dos registros. O cadastro também prevê configurações de segurança e especifica as classes de negócio utilizadas tanto na interface do usuário quanto no servidor de aplicação.

Em cada cadastro é informada a tabela correspondente no banco de dados. Como exemplo, o cadastro de Clientes utiliza a tabela PESSOAS. A partir dessa tabela, o sistema identifica os campos disponíveis e cria, em tempo de execução, toda a estrutura necessária para manipulação dos registros.

Além disso, o cadastro disponibiliza diversos recursos que garantem a integridade das informações e automatizam parte dos processos, como:

  • Preenchimento automático de campos previamente configurados durante a inclusão de novos registros, incluindo controles internos como a geração da chave primária.
  • Execução automática das regras de negócio implementadas nos scripts da tabela, como preenchimento de informações, validações e demais procedimentos personalizados.
  • Validação dos campos obrigatórios durante a gravação do registro, além da execução do mecanismo de scripts responsável pelas regras de negócio.

Nos cadastros que possuem registros relacionados, como por exemplo Documentos e Itens do Documento, são utilizados sub-cadastros, permitindo que os relacionamentos entre as informações sejam gerenciados automaticamente pelo sistema.

Funcionamento

O cadastro utiliza a estrutura definida na tabela relacionada para construir dinamicamente a interface de usuário. A partir dessa configuração, o sistema identifica os campos disponíveis, organiza-os em páginas, aplica regras de segurança, executa scripts e disponibiliza todos os recursos necessários para manipulação dos registros.

Dessa forma, alterações realizadas na configuração do cadastro passam a refletir diretamente no comportamento da tela correspondente, reduzindo a necessidade de alterações no código da aplicação.

Registro do Cadastro

Configurações Gerais

  • Nome: Corresponde à identificação única do cadastro e não pode conter caracteres especiais ou espaços. Após a gravação, o nome não poderá mais ser alterado, pois passa a ser a chave de identificação do cadastro. Nos cadastros personalizados pelo cliente, o sistema acrescenta automaticamente o prefixo C_, evitando conflitos com cadastros nativos.
  • Legenda: Título apresentado ao usuário na parte superior da tela.
  • Tabela: Tabela do banco de dados utilizada pelo cadastro.
  • Sem Vínculo: Disponível apenas para sub-cadastros. Quando desmarcado, o sistema exige a configuração do campo Parente para controlar automaticamente o relacionamento entre cadastro pai e cadastro filho. Quando marcado, todos os registros da tabela poderão ser exibidos, podendo ser utilizados filtros SQL para restringir sua visualização.
  • Parente: Disponível apenas para sub-cadastros. Define o campo responsável pelo relacionamento entre o cadastro pai e o cadastro filho.
  • Sequência: Define a ordem de exibição dos sub-cadastros quando houver mais de um relacionado ao cadastro principal.
  • Classe no Cliente: Classe de negócio utilizada pela aplicação Desktop.
  • Classe no Servidor: Classe de negócio utilizada pelo servidor de aplicação.

Tipo de Cadastro

Determina o layout utilizado para construção da tela.

Grid

Constrói a tela utilizando um grid para pesquisa, seleção e edição dos registros.

  • Tamanho Grid: Define a largura do grid em pixels.
  • Tipo de Exibição Grid: Permite exibir o grid à esquerda, à direita ou maximizado.
  • Exibir Grupo: Exibe a área de agrupamento de colunas no grid.
  • Vazio: Quando marcado, nenhum registro será carregado automaticamente, sendo necessária uma pesquisa para exibição dos dados. Recomenda-se esta opção para tabelas com grande volume de registros.
  • Auto Exibir: Após gravar um registro, retorna automaticamente para o grid.
  • Mult Select: Permite selecionar vários registros simultaneamente.
  • Ajustar Colunas: Ajusta automaticamente a largura das colunas do grid.
Estrutura

Utilizado em cadastros hierárquicos, semelhantes a planos de contas ou árvores de classificação.

  • Registro Pai: Campo correspondente ao registro pai.
  • Máscara: Estrutura utilizada para formação da hierarquia. Exemplo: 9.99.999.
  • Estrutura: Campo que armazenará a estrutura completa gerada pelo sistema.
  • Código Estrutura: Campo responsável pelo código individual de cada nível.
  • Tamanho Grid: Define a largura do grid.
Um a Um

Constrói a tela sem utilização de grid, exibindo apenas um registro por vez.

Um Registro

Utilizado para cadastros que possuem apenas um registro, como parâmetros e configurações gerais do sistema.

Demais Configurações

  • Maximizar: Exibe o cadastro ocupando toda a área disponível da aplicação.
  • Data / Hora: Preenchimento automático da data e hora da última alteração.
  • Pré-Criar: Realiza previamente toda a criação da estrutura do cadastro.
  • Ícone: Ícone utilizado no título da tela.
  • Segmento: Restringe a utilização do cadastro aos clientes que possuam o segmento correspondente em sua licença.
  • Ajuda (Link Wiki): Endereço da documentação correspondente na Wiki. Quando informado, o sistema disponibiliza automaticamente o botão de ajuda.
  • É Sistema: Indica que o cadastro pertence ao sistema padrão e não pode ser alterado diretamente.

Segurança

Define as permissões e comportamentos relacionados à manipulação dos registros.

  • Alterar: Permite alteração dos registros.
  • Incluir: Permite inclusão de novos registros.
  • Excluir: Permite exclusão de registros.
  • Condição de Editabilidade: Expressão SQL utilizada para determinar quando um registro poderá ser editado.
  • Auto Leitura: Nos sub-cadastros, acompanha automaticamente o estado de leitura do cadastro pai.
  • Permite Script: Habilita a utilização de scripts personalizados.

Páginas

As páginas permitem organizar os campos do cadastro em abas, facilitando a navegação e melhorando a organização das informações.

  • Posição das Páginas: Define onde as abas serão exibidas.
  • Rotação: Altera a orientação do título das páginas.
  • Largura Tab: Define uma largura fixa para todas as abas.
  • Páginas: Relação das páginas pertencentes ao cadastro.
    • Sequência: Ordem de exibição.
    • Nome: Identificador único da página.
    • Legenda: Nome apresentado ao usuário.
    • Segmento: Restringe a utilização da página por segmento.
    • Margens: Cria automaticamente um espaçamento interno na página.
    • É Sistema: Indica que a página pertence ao sistema.
    • Data / Hora: Data e hora da última alteração.
    • Botão Campos: Permite configurar os campos exibidos na página e personalizar suas propriedades.

Botões do Cadastro

Permite criar botões personalizados que serão exibidos na barra superior da tela.

  • Sequência
  • Nome
  • Legenda
  • Ícone
  • Atalho
  • Submenu Pai
  • Condição de Editabilidade
  • Condição de Visibilidade
  • Descrição
  • Exibir Legenda
  • Segmento
  • Grupo
Tipo de Execução
  • Padrão: Executa procedimentos e scripts do servidor.
    • Procedimento
    • Script
    • Mensagem de Confirmação
    • Transação Automática
  • Cadastro: Abre outro cadastro relacionado.
  • Formulário: Executa um formulário personalizado.
  • Impressão: Executa formatos de impressão.
  • E-mail: Executa formatos de impressão para envio por e-mail.
  • Data / Hora: Data da última alteração.

Filtros

Permite configurar filtros padrões utilizados pelo cadastro.

  • Filtro: Define o cadastro de filtro utilizado.
  • Estilo do Filtro: Determina a forma de apresentação do filtro para o usuário.
  • Filtro SQL: Permite informar uma expressão SQL utilizada para restringir os registros apresentados pelo cadastro.

Conclusão

O cadastro de Cadastros é um dos principais componentes de configuração do PHERP, sendo responsável por definir a estrutura, comportamento e funcionamento das telas do sistema.

Por meio dele é possível configurar a tabela utilizada, organizar os campos em páginas, criar botões personalizados, definir regras de segurança, condições de editabilidade e demais recursos necessários para a construção dinâmica dos cadastros.

Sua utilização proporciona maior flexibilidade ao sistema, permitindo centralizar configurações e facilitar a manutenção, personalização e evolução das funcionalidades do ERP.

Assuntos Relacionados

Tabelas

Condição de Editabilidade

Informações_de_Registros

Disponível em "http://wiki.phsys.com.br/index.php?title=Cadastros&oldid=6981"