PHSYS - Wiki

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 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:

• 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 cadastro com registros relacionados, como por exemplo documento e itens do documento, são utilizados sub-cadastros que serão relacionados automaticamente para o usuário.

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.
• Legenda Título do cadastro que será exibido para usuário na parte superior da tela.
• Tabela: Tabelas do banco de dados relacionada ao cadastro.
• 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, 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.
• 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.
• 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.
  • 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.
    • 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.
    • 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.
    • 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.
  • 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.
    • 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.
  • 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.
• 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.
• Auto Leitura: Quando marcado em sub-cadastros, o estado de leitura do cadastro é alterado automaticamente conforme o cadastro pai.
• 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.
• 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.
• 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.
• Visualizar Informações de Registro: Quando marcado, está disponível na barra de ferramentas superior do cadastro, atalho para consulta informações de registros.
• É 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.

Páginas

• Posição das Páginas: Determina a posição que serão exibidas as paginas cadastro, sendo a esquerda, direita, superior ou inferior.
• 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.
• 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.
  • 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.
  • 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.
  • Margem: 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.
  • 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.

Segurança

• Alterar: Permitir alteração realizar alterações.
• Incluir: Permitir inclusão de novos registros.
• 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'.

Botões

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:
• Nome:
• Legenda:
• Icone:
• Atalho:
• Sub-Menu Pai:
• Cadastro:
• Descrição:
• Exibir Legenda:
• Segmento:
• Grupo:
• Data / Hora:

Filtros

• Filtro:
• Estilo do Filtro:
• Filtro SQL: