Mudanças entre as edições de "Cadastros"
(→Conclusão) |
|||
| (32 revisões intermediárias por 3 usuários não estão sendo mostradas) | |||
| Linha 1: | Linha 1: | ||
| − | + | ==='''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. | |
| − | *'''Nome:''' Corresponde | + | 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. |
| − | *'''Legenda''' Título | + | |
| − | *'''Tabela:''' [[Tabelas]] do banco de dados | + | Além disso, o cadastro disponibiliza diversos recursos que garantem a integridade das informações e automatizam parte dos processos, como: |
| − | *'''Sem | + | |
| − | *'''Parente:''' Disponível | + | * 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. |
| − | *'''Sequência:''' | + | * 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. |
| − | *'''Classe no Cliente:''' Classe de negócio | + | * 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. |
| − | *'''Classe no Servidor:''' Classe de negócio utilizada | + | |
| − | + | 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'''=== | ||
| + | |||
| + | ===='''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:''' [[Tabelas|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. | ||
| + | |||
| + | * '''Visualizar Informações de Registro:''' Disponibiliza o atalho para consulta das [[Informações_de_Registros|Informações de Registros]]. | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ===='''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|Condição de Editabilidade]] | ||
| + | |||
| + | [[Informações_de_Registros|Informações de Registros]] | ||
Edição atual tal como às 19h39min de 1 de setembro de 2026
Índice
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.
- Visualizar Informações de Registro: Disponibiliza o atalho para consulta das Informações de Registros.
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