manual de funcionalidades do framework
APRESENTAÇÃO
Este manual tem o objetivo de apresentar os principais elementos na interface web do Sistema UNUM e dos produtos criados utilizando-se a plataforma de desenvolvimento da UNUM. Com a sua leitura será possível familiarizar-se com o sistema, através de exemplos, figuras, procedimentos passo-a-passo, além de poder contar com informações que irão otimizar o trabalho do usuário final.
Para um melhor aproveitamento deste manual, sugerimos a consulta ao manual Teclas de Atalho.
CONHECENDO A INTERFACE WEB
Os produtos da UNUM criados com a plataforma de desenvolvimento da empresa, o UNUMengine, possuem como principal característica a utilização da interface web. Para utilizar qualquer um destes produtos, é importante familiarizar-se com a interface e, para isto, estaremos descrevendo, detalhadamente, cada parte das telas do sistema e as teclas de atalhos que poderão ser utilizadas, trazendo agilidade e produtividade para o usuário final.
Veja a seguir os principais elementos da interface:
Menu Principal
Barra de Processos Ativos
Barra de Ações
Grade
Barra de Título
A “Barra de Título” não pertence ao Sistema UNUM, mas ao navegador (browser) utilizado para acessar o sistema. Nela, além das informações do browser e dos botões para maximizar, minimizar e fechar o navegador, também estão identificados alguns elementos do sistema, como o nome da base acessada, porta de comunicação e nome do usuário (login).
Menu Principal
O “Menu Principal” é a única barra do sistema que fica visível de forma permanente. Através dele, o usuário poderá fazer pesquisas, navegar pelas classes do sistema, imprimir relatórios, ativar as telas de ajuda, verificar a quantidade de tarefas pendentes e encerrar a sessão.
Toda atividade realizada na interface web inicia-se com algum procedimento a ser realizado a partir do “Menu Principal”. Veja, a seguir, a descrição dos botões presentes nesta barra:
Botões
Teclas de Atalho
[Ctrl]+[Shift]+[B]
[Ctrl]+[Shift]+[I]
[Ctrl]+[Shift]+[M]
[Alt]+[F1]
[Ctrl]+[Shift]+[H]
Funções
Ao preencher o campo localizado à esquerda deste botão e clicar em “Buscar”, serão apresentadas todas as ocorrências do termo pesquisado, como cadastros, consultas etc.
Abre a árvore de navegação principal do sistema.
Imprime o documento que está ativo.
Apresenta informações sobre campos e processos. O usuário pode clicar no campo e em seguida nesse botão. Também é possível obter ajuda do processo, clicando fora da grade.
Encerra a sessão atual. Também permite que a sessão seja reiniciada em caso de expiração.
Barra de Processos Ativos
Esta barra apresenta todas as guias que foram acessadas pelo usuário em uma dada sessão e que ainda não foram fechadas. Com esta nova funcionalidade, pode-se acessar diversos processos sem precisar clicar freqüentemente no botão “UNUM”.
Veja as características desta barra:
As guias com cores mais claras (“Root”, “Groups And Users” e “Key Range of Keys”) demonstram que o processo está carregado, mas fora de foco no momento. Elas podem ser acessadas com um clique simples do mouse ou através das teclas [Ctrl] + [<] (move o foco para a guia anterior) ou [Ctrl] + [>] (move o foco para a próxima guia);
A guia no tom de verde mais escuro (“Groups And Users”) está ativa, ou seja, é a guia que está sendo utilizada pelo usuário naquele momento;
O botão
([Ctrl]+[Q]) permite que o usuário feche a guia, disponibilizando mais espaços para a abertura de novos processos.
Importante: Não é possível navegar ou utilizar outra guia enquanto o sistema estiver aguardando a resposta de execução em uma guia.
Barra de Ações
Esta barra apresenta todas as ações que podem ser realizadas na guia em uso atualmente. As ações apresentadas irão variar dependendo da guia que está sendo executada e do poder de acesso configurado para o usuário. Na barra, também são encontradas setas de navegação que permitem, facilmente, voltar para a tela anterior (
voltar ou back) ou avançar para a próxima tela ( avançar ou foward).
Grade
O principal objeto da interface web é a grade (ou tabela), que apresenta os registros cadastrados no sistema. No decorrer do uso do Sistema UNUM, você deverá aprender a usar a grade de forma bem intuitiva.
Existem duas formas de visualizações distintas: o Modo Ficha e o Modo Tabela. O Modo Tabela permite enxergar a totalidade dos registros organizados de forma tabular, como em uma planilha convencional. Já o Modo Ficha é apresentada quando se deseja incluir, editar ou visualizar um registro por vez.
A seguir será apresentada a nomenclatura para cada parte da tela, utilizando-se grades nos formatos Modo Tabela e Modo Ficha.
Nomenclatura no Modo Tabela:
Barra de Título da grade
Títulos das Colunas da grade
Registros
Nomenclatura das barras no Modo Formulário:
Barra de Título da grid
Títulos dos Campos com Lookup
Títulos dos Campos sem Lookup
Campos
FUNCIONALIDADES DA GRADE
Barra de Título da grade
Além do título da grid que está sendo apresentada, esta barra também possui botões que permitem a navegação por outros registros, tanto no formato Table View quanto no Form View, e ações para cancelar a edição de campos, adicionar registros, salvar alterações, mudar tipo de visão e maximizar ou minimizar a grade.
Veja abaixo, respectivamente, as imagens de uma barra de título ativa e uma inativa.
Botões
Serão apresentados e detalhados aqui os principais botões utilizados nas grades do Sistema UNUM.
É importante lembrar que os ícones dos botões podem ser diferentes se sistema estiver usando outro tema diferente do tema usado neste manual.
Botão
Mudar visão
Ícone
Shift+Enter
Insert
Ctrl+Delete
Ctrl+M
Esc
Atalho
Funcionalidade
Muda visão da grade dentre os dos modos de visão disponíveis: Modo Ficha e Modo Tabela.
Inserir
Excluir
Confirmar
Insere um novo registro na grade.
Excluir um registro da grade. Antes irá aparecer uma janela de confirmação.
Confirma uma inserção ou alteração de registros na grade.
Cancela uma inserção ou alteração de registros na grade que está sendo editado.
Minimiza a grade, deixando visível apenas a Barra de Título da grade.
Cancelar
Minimizar
Maximizar
Localizar
Primeiro
Anterior
Próximo
Último
Histórico de Alterações
Exportar dados
Ctrl+Shift+L
Maximiza a grade, apresentando todo o conteúdo da grade.
Localiza registros na grade. É possível pesquisar em um campo ou em todos os campos.
No Modo Tabela, vai para o primeiro registro da grade. No Modo Ficha, mostra o conteúdo do primeiro registro.
Vai para o registro anterior da grade, em relação ao que está sendo visualizado.
Vai para o próximo registro da grade, em relação ao que está sendo visualizado.
No Modo Tabela, vai para o último registro da grade. No Modo Ficha, mostra o conteúdo do último registro.
Mostra o histórico de alterações de um registro ou de um campo da grade.
Ctrl+Home
Pg Up
Pg Down
Ctrl+End
[Teclas numéricas]
Exporta os dados da grade para os formatos Excel, CSV ou TXT. Porém, nem toda grade possui esta funcionalidade.
Registro Selecionado
Quantidade de Registros
Indica a quantidade de registros da grade atual. Esta informação não pode ser editada.
Indica o número do registro que deverá ser selecionado ou que está em edição.
Títulos das Colunas da grade
A barra com os títulos das colunas na grade somente é apresentada no Modo Tabela. Nela são mostrados os títulos das colunas da tabela exibida. No Modo Ficha, estes títulos são denominados de “Títulos dos Campos” (com ou sem lookup).
O ícone presente no lado esquerdo permite selecionar todos os registros da tabela com um só clique. O usuário também pode marcar um ou mais checkbox e em seguida clicar no ícone para inverter a seleção, ou seja, o(s) registro(s) que ele havia selecionado será(ão) desmarcado(s) e o restante ficará marcado.
Registros
Também são mostrados apenas no Modo Tabela. Apresenta a relação de todos os campos cadastrados na grade atual.
Clicando-se sobre um campo, este ficará selecionado e poderá ser editado (caso o usuário tenha permissão para este procedimento).
A caixa de seleção presente na grade (ao lado dos registros) permite selecionar um ou mais registros para executar as ações dos botões localizados na Barra de Título da grade.
Campos
Local onde o usuário irá digitar os dados. Após preenchê-lo com as informações desejadas, o usuário deverá, obrigatoriamente, clicar no ícone para gravar as alterações ou para cancelar.
Campos com Lookup
Os campos com lookup são campos que possuem tabelas auxiliares que ajudam o usuário no preenchimento da informação, fazendo referências a registros de outras classes ou arquivos da iVFS (Virtual File System).
Praticamente em todas as telas do Sistema UNUM há um tipo de campo o qual chamamos de Campo Lookup. Na figura abaixo, temos um exemplo de um campo lookup chamado Procedência.
À medida que o usuário digita os dados, aparecem palavras ou frases que podem preencher aquele campo (esta ação é chamada speed fill, auto-preenchimento ou preenchimento rápido).
O preenchimento dos campos lookup pode ser feito diretamente na caixa de texto ou através do clique no botão (drop-down), que fica logo ao lado da caixa de texto. O usuário também tem acesso à tabela auxiliar através das teclas <barra de espaço> + <tab>.
Ao realizar um destes procedimentos, será mostrada a tabela contendo todas as opções selecionáveis que podem ser utilizadas para preencher o campo lookup, conforme a figura a seguir.
O usuário deverá escolher uma ou mais opções e clicar no botão Ok. Caso deseje preencher o campo com a totalidade das opções apresentadas, basta clicar no botão Todos. Para fechar a nova grade sem escolher nenhuma das opções, o usuário deverá clicar no botão Cancelar.
Como já dito anteriormente, cada registro de um campo com lookup tem referência a um registro. Se esse registro possuir um relacionamento com imagens cadastradas, a imagem definida na configuração como principal será exibida na grade ao lado do campo com lookup. Tanto no modo tabela como no modo formulário.
Ao expandir a lista de valores, há uma coluna onde é exibida a imagem que está vinculada ao registro. Ao passar o cursor do mouse sobre a imagem, é possível visualizá-la em tamanho ampliado.
Títulos dos Campos sem Lookup
Na interface Web, os campos que não são lookup diferenciam-se dos demais por não possuirem ao lado o botão (drop-down). Esses campos não possuem o recurso de auto-completar por se tratarem de campos que geralmente possuem informações exclusivas, não sendo vinculados a outras tabelas.
Importante: Os campos identificados por asterisco (*) são de preenchimento obrigatório.
LINK
Além dos elementos apresentados anteriormente, o usuário irá se deparar, ao acessar grades, relatórios e processos, com diversos links. Os links, em arquivos HTML, permitem relacionar diversas páginas, através de navegação não-linear. Assim também é seu funcionamento no Sistema UNUM no qual, o usuário pode, ao acessar um relatório sintético, por exemplo, ter acesso às informações detalhadas do dado que está sendo apresentado.
Os links são diferenciados das demais fontes do sistema por estarem em negrito e na cor azul (layout padrão). Às vezes, aparecem entre colchetes. Sua utilização será indicada pelo desenvolvedor no momento da criação de relatórios ou grades. Abaixo, colocamos alguns exemplos de utilização do links no sistema.
Abaixo, é apresentado o relatório "Usuários habilitados". Pode-se nele visualizar alguns links dos registros presentes na coluna “Estado atual do usuário”; ao clicar nele, o usuário acessa outro relatório ou cadastro com informações detalhadas do registro.
AÇÕES DE CONSULTAS
As consultas (ou relatórios) são os principais instrumentos de análise e decisão. Através delas, o usuário poderá explorar todas as informações existentes no sistema. Para isso, ele deverá definir como deseja obter as informações para otimizar a análise de resultados e direcioná-las, especificamente, para realidade de seu negócio, sempre com o mínimo de esforço.
Nomenclatura de componentes:
Nome da consulta;
Botões com ações disponíveis.
A seguir apresentamos as principais ações disponíveis nas consultas:
Executar ([Ctrl]+[Shift]+[e])
Esta é com certeza a ação mais utilizada na geração das consultas. Após o preenchimento das variáveis, o usuário aciona o comando “Executar” para gerar o relatório no formato HTML.
Clique no botão “UNUM” localizado no “Menu Principal”;
Abra a árvore de opções, clicando no ícone (expandir), localizado do lado esquerdo, até chegar à consulta desejada;
Clique sobre o nome da consulta (as consultas são representadas pelo ícone apresentado na figura anterior);
Preencha as variáveis solicitadas. Lembramos que os campos marcados com asterisco (*) são obrigatórios e a consulta será realizada apenas após o seu preenchimento;
Clique na opção “Executar” na “Barra de Ações” ou acione as teclas de atalho [Ctrl]+[Shift]+[e]. A opção Executar também pode ser acionada através do clique na tecla [Enter] após o preenchimento da última variável da consulta.
Imprimir em Texto ([Ctrl]+[Shift]+[p])
Essa ação permite salvar relatórios em formato texto (.txt) ou imprimi-los em impressoras matriciais. Através desta funcionalidade, todos os relatórios (consultas) desenvolvidos exclusivamente com o Simple Layout poderão ser convertidos para txt, sem necessitar de nenhum tratamento especial em seus códigos.
O usuário poderá optar entre visualizar o relatório e posteriormente imprimi-lo em texto ou fazê-lo diretamente.
Clique no botão “UNUM” localizado no “Menu Principal”;
Abra a árvore de opções, clicando no ícone (expandir), localizado do lado esquerdo, até chegar à consulta desejada;
Clique sobre o nome da consulta;
Preencha as variáveis solicitadas. Lembramos que os campos marcados com asterisco (*) são obrigatórios e a consulta será realizada apenas após o seu preenchimento;
Clique na opção “Imprimir em Texto” na “Barra de Ações” ou acione as teclas de atalho [Ctrl]+[Shift]+[p]. Com este procedimento, não haverá visualização do relatório na tela. Caso deseje checar o relatório antes de imprimi-lo, selecione primeiro “Executar” e, após a sua geração, clique em “Imprimir em Texto”.
Preencha os campos da página que será aberta:
Driver(*) – Informe o driver da impressora que será utilizada na impressão do relatório. Este driver contém as informações de inicialização da impressora e de configuração da página;
Destino(*) – No caso da utilização de impressora matricial, deverá ser informado o seu path/caminho (Ex.: \\COMPUTADOR2\Epson). Para a geração de arquivo TXT, informe o local onde ele deverá ser gerado e o seu nome (Ex.: C:\relatorio1.txt);
Página Inicial(*) – Indique a página inicial no caso de impressão de intervalo de páginas. Se desejar imprimir todo o relatório, deixe a opção preenchida com “1”.
Página Final(*) - Indique a página final no caso de impressão de intervalo de páginas. Se desejar imprimir todo o relatório, deixe a opção preenchida com “1000000”.
Na “Barra de Ações”, clique no botão “Imprimir”.
Enviar por e-mail ([Ctrl]+[Shift]+[n])
Essa ação permite enviar relatórios por e-mail para quaisquer destinatários. A opção só ficará disponível para utilização após a geração do relatório a ser enviado.
Clique no botão “UNUM” localizado no “Menu Principal”;
Abra a árvore de opções, clicando no ícone (abrir ou expandir), localizado do lado esquerdo, até chegar à consulta desejada;
Clique sobre o nome da consulta;
Preencha as variáveis solicitadas. Lembramos que os campos marcados com asterisco (*) são obrigatórios e a consulta será realizada apenas após o seu preenchimento;
Clique na opção “Executar” na “Barra de Ações” ou acione as teclas de atalho [Ctrl]+[Shift]+[e].
Clique na opção “Enviar por e-mail” na “Barra de Ações” ou acione as teclas de atalho [Ctrl]+[Shift]+[n].
Preencha os campos da página que será aberta:
Nome do destinatário(*) – Informe o nome da pessoa que deverá receber o relatório. Pode ser indicado mais de um nome de destinatário, bastando separá-los por ponto-e-vírgula(;);
E-mail do destinatário(*) – Informe o e-mail da pessoa que deverá receber o relatório. Pode ser indicado mais de um e-mail de destinatário, bastando separá-los por ponto-e-vírgula(;);
Assunto(*) – Informe o título do e-mail;
Informações adicionais – Preencha com informações que deverão ser enviadas para o destinatário.
Na “Barra de Ações”, clique no link “Enviar”.
INFORMANDO DATAS NO SISTEMA
O Sistema UNUM, através da interface Web, possibilita a utilização de atalhos para a definição de datas, com o objetivo de agilizar o processo de digitação. Veja na tabela abaixo, quais são os atalhos:
Vale lembrar que o preenchimento da data será realizado após o usuário sair do campo, clicar na tecla [TAB] ou na tecla [Enter].
Além disso, não é necessário digitar as barras de separação (/).
O ano pode ser indicado por apenas dois dígitos (os dois últimos). Geralmente, o sistema segue o padrão DD/MM/AAAA (dia/mês/ano).
Segue abaixo uma tabela como exemplos: tomando-se a data de 24/04/2004 como referência, o sistema preencherá os campos data da seguinte forma: