Telescope Versao 2

Índice

Atributos

ADS2.CAD_ATRIBUTE

Descrição

Tela de cadastramento de um atributo.
Esta interface é chamada no contexto de uma entidade. Ver Entidades.

Esta interface é usada em diferentes guias do sistema. Clique nos links de navegação abaixo para obter maiores informações.

Cadastro de Bibliotecas:

Sub-módulo para atributos:

Campos:

Nome global do atributo, calculado automaticamente através da concatenação do nome do sistema + "." + nome da entidade + "." + nome do atributo.
Serve como identificação única do elemento no repositório.
Título utilizado para identificar os campos ligados a este atributo nas interfaces (label). Geralmente, o título é um substantivo no singular. Abreviaturas podem ser utilizadas quando não atrapalharem o entendimento de seu significado.

A abreviatura é um recurso convencional da língua escrita que consiste em representar de forma reduzida certas palavras ou expressões. A regra geral para abreviatura das palavras é simples. Basta escrever a primeira sílaba e a primeira letra da segunda sílaba, seguidas de ponto abreviativo.
Nome lógico do atributo. Este nome será utilizado como nome de coluna da respectiva tabela no banco de dados e como nome dos elementos de programação ligados ao mesmo. Sugere-se utilizar o nome do título, convertido para caixa alta, removendo preposições ou outras elementos de ligação, substituindo caracteres acentuados, cedilhas e outros para caracteres da faixa padrão do ASCII e substituindo espaços por "_".
Indicador (*) dos atributos requeridos.
Domínio formatado
Descrição do atributo incluindo os valores permitidos.
Domínio padrão para o atributo. O domínio do atributo define, além do tipo de dado, o comportamento padrão nas interfaces do sistema. Quando são previstas variações, utilize o domínio mais utilizado.

Atributos que são chaves únicas de entidades que não representam muitos valores, poderão ser definido com um domínio de lista de opções. Nestes casos, a respectiva interface de cadastro deverá ter o domínio redefinido para utilizar um texto de entrada de dados.

O domínio também pode ser definido através de uma sequencia do sistema. Neste caso, o tipo de dado dependerá do domínio da respectiva sequencia.

Além disso, o domínio também pode ser definido por uma entidade. Nesta caso ao ser incluído, o atrbuto passará a ser do domínio ADSRT.ID e uma regra de relacionamento n:1 é automaticamente criada.

Texto livre para descrever o atributo.

Este texto é utilizado na documentação do sistema tanta (inclusive como sugestão de "hint" para os campos nas interfaces) e para a equipe de desenvolvimento.

A descrição do atributo deve seguir as seguintes regras:
  • O primeiro parágrafo deve estabelecer o conceito do que o atributo representa. Isso deve ser feito de forma clara, precisa e bem definida.
  • Os parágrafos seguintes devem responder as seguintes perguntas:
    • Porque o sistema precisa deste atributo?
    • Onde, quando e como este atributo é utilizado?
    • Quais as regras de preenchimento deste atributo (se houver) ou como este atributo é calculado (se for o caso)?
  • Deve utilizar uma linguagem simples, voltada para usuários finais e especialistas de negócio.
  • Não deve utilizar termos técnicos de tecnologia de informação. Informações técnicas relacionadas ao desenvolvimento de sistemas deve ser registradas nas observações.
  • Pode utilizar termos técnicos relacionados ao contexto de negócio ao qual o atributo está relacionado quando se espera que o público que irá interagir com este atributo tenha o respectivo conhecimento.
  • As definições devem ser descritas utilizando uma conjugação verbal no presente. Usar frases tipo "Este atributo é utilizado para...". Jamais conjugar no futuro "Este atributo será utilizado para...".
  • Nos casos de atributos que possuem uma lista de valores, deve-se considerar as descrições dos valores como parte da descrição, ou seja, as descrições dos valores acabam direta ou indiretamente respondendo as questões acima.
Indica se o atributo é opcional na entidade, ou seja, que pode ser criado um registro sem a informação do mesmo (valor nulo).
Como base nesta informação, o sistema irá sugerir quando os respectivos campos nas interfaces são de preenchimento obrigatório ou não e como as estruturas de banco de dados serão criadas.
Sequencia lógica do atributo. Esta sequencia é utilizada na construção padrão dos formulários de entrada de dados e na apresentação da documentação das entidades.
Valor a ser utilizado caso o registro seja criado sem informar um valor para este atributo. Alguns domínios aceitam algumas convenções para valores informados entre colchetes. Por exemplo:
  • [SYSDATE] - Representa a data e hora o sistema para campos do tipo data e data/hora.
  • [USER_ID] - Representa o ID do usuário que está logado na sessão.
  • [XXXX] - Representa uma variável de sessão ou preferencia de usuário/sistema.

Veja a documentação de cada domínio para maiores detalhes.
Tamanho máximo do atributo. Serve como regra para limitar o tamanho do texto informado. Quando nao informado, o sistema não estabelece nenhum limite para o tamanho (ou adota o tamanho limite pré-estabelecido no respectivo domínio).
Largura padrão a ser utilizada para os campos ligados a esse atributo. Serve apenas como uma orientação para o tamanho do campo na interface do usuário.
Para campos numéricos, indica o número de decimais a serem utilizados. Para os demais domínios, informa a altura física do campo na interface. A convenção utilizada para a altura depende do domínio. Pode representar o número de linhas ou número de pixels. Ver a documentação do domínio para maiores detalhes.
Formatação padrão para este atributo. A convenção do formato dependem de cada domínio. Normalmente o formato é estabelecido por um conjunto de propriedades informadas no padrão "chave:valor;". Veja a documentação de cada domínio para maiores detalhes.
Valores de exemplo para o atributo. Usado tanto para documentação como para prototipação.
Informe um exemplo para cada linha.
Indica quando o atributo pode ser utilizado para classificar um grupo de registros. Quando definido que sim, permite agrupar os registros das listas pelo seu valor, totalizando os atributos marcados como "Summarize".
  • Não
  • Sim
Indica quando faz sentido criar totais deste atributo quando listamos vários registros (agrupados ou não). Um valor total de um pedido, por exemplo, deveria ser marcado como "Sim" (faz sentido somar os valores dos pedidos). Mas o preço unitário de um produto não faz sentido somar.
  • Não
  • Sim
Texto a ser utilizado para representar valores nulos. Por padrão, valores nulos em uma lista aparecem em branco. Com este atributo é possível definir, por exemplo, que um valor nulo apareça com o texto "Não informado".
Nome físico da coluna no banco de dados. Caso não informado, assume o próprio nome lógico do atributo. Isso pode ser importante quando o nome lógico do atributo não pode ser utilizado como nome de coluna no banco de dados (o nome do atributo é composto por uma palavra reservado no banco de dados, quando o tamanho excede o tamanho máximo para um nome de coluna, utiliza algum caractere especial, etc.)
Expressão SQL que deve ser usada para gerar o autocomplete para este campo. O SQL deverá resultar 4 colunas que devem ter os seguintes nomes:
  • ID (uso do registro)
  • VALOR (valor que será colocado no campo)
  • DESCRICAO (texto que poderá acrescentar uma informação a mais sobre o registro)
  • PESQUISAR (texto onde o sistema irá pesquisar com o operador LIKE)
Anotações técnicas relacionadas a este atributo. Estas anotações não vão para o manual do usuário.

Operações

Topo

Listar

Apresenta uma lista com os registros que atendem os filtros informados. Clique no registro para selecioná-lo. Caso o registro desejado seja o primeiro (ou único), é possível selecioná-lo pressionando a tecla ENTER.
Topo

Novo

Tela de inclusão de um novo atributo. Ao preencher o campo título, o nome do atributo é automaticamente sugerido.
Se o atributo correponde a um relacionamento com uma entidade estrangeira, no lugar do domínio, informe o nome global da entidade desejada. O sistema irá incluir a FK e ajustar o domínio automaticamente.
Topo

Consultar

A operação de consulta é executada quando o usuário clica em um registro da lista ou após a inclusão de um novo registro.
A operação consiste em uma tela que apresenta os dados detalhados do registro específico apenas para consulta e oferece todas as operações possíveis sobre ele (alterar, excluir, etc.).
Topo

Alterar

Tela que permite a alteração de um registro.
Topo

Update MR

Tela que permite a alteração de um registro.
Topo

Excluir

A exclusão do registro pode ser disparada a partir da tela de consulta e/ou de manutenção do mesmo.
O registro somente será excluído se todas as condições necessárias forem encontradas, gerando um erro, caso alguma destas condições não estiver sendo atendida.
Topo

Pesquisar

Ao pesquisar, o usuário poderá informar critérios de filtro para listar apenas os registros desejados. Normalmente depois de informar os filtros desejados, o usuário deverá executar a operação "Listar".
Obtenha maiores detalhes em Como utilizar a tela de pesquisa?.
Topo

Pesquisa simples (SEARCH)

Campos utilizados para pesquisa genérica
Topo

Importar

Funcionalidade que permite importar dados para o bloco desejado.
Topo

Exportar

Funcionalidade que permite exportar os dados de um bloco.
Topo

Normalizar

Tela que que normaliza o atributo criando uma nova entidade e um relacionamento deste atributo para lá.