igrpweb Guia inicial rápido Cliente NOSi igrpweb Referência Versão 1.00 Status
Conteúdo Enquadramento... 2 1 Iniciando no igrpweb... 3 1.1 Criando aplicações... 5 1.2 O File editor... 7 1.3 Application Builder... 8 1.4 Criando páginas... 9 2 Criando Conexões com bases de dados... 12 3 Executando uma aplicação... 14 4 Aplicações sem Home Page definida e Páginas sem conteúdo... 15 1 P á g i n a
ENQUADRAMENTO Este documento vai guiar o desenvolvedor de forma rápida na criação de aplicações utilizando o framework igrpweb, tendo como foco os primeiros passos necessários para a criação de aplicações e sua execução, sem entrar nos detalhes do processo. Através dos documentos indicados no Main Menu, temos acesso à informações sobre os diversos recursos disponíveis no framework, que nos podem auxiliar na criação de nossas aplicações. 2 P á g i n a
1 INICIANDO NO IGRPWEB Para começar vamos para a página do framework [Fig 1] e fazemos o login. Fig 1 igrpweb [página de login] Uma vez submetidas as credencias temos acesso a página inicial do igrpweb [Fig 2]. Fig 2 - Home Page do igrpweb Nesta página temos acesso a algumas aplicações: Tutorial IGRP [1] documentação do igrpweb; IGRP Studio [2] o ambiente de desenvolvimento do framework; Outras aplicações as aplicações que desenvolvemos e outras a que fomos convidados, sendo este o local padrão para a sua execução. 3 P á g i n a
Entrando no IGRP Studio temos acesso à página inicial do ambiente de desenvolvimento, a Home Page Builder [Fig 3]. Esta página oferece acesso a todas as funcionalidades necessárias para o desenvolvimento de aplicações no igrpweb, acessíveis no menu do lado esquerdo, nomeadamente, Application Builder, Access Management, SQL Tool e Domain Management. 4 P á g i n a
1.1 Criando aplicações 1. Para criar uma nova aplicação clicamos sobre o botão [Fig 3], para acessarmos o formulário para o efeito [Fig 4]. Alternativamente podemos criar aplicações a partir do Application Builder [Fig 9], acessível através do menu do lado esquerdo. Fig 3 Home Page Builder [criando aplicação] 2. Preenchemos o formulário da página que se abrirá [Fig 4]. Fig 4 Application Builder [formulário de criação de aplicações] 5 P á g i n a
Valor dos principais campos do formulário: Nome nome da aplicação no layout do igrpweb [pode ser alterado posteriormente]; Código atributo único para cada aplicação, trata-se de um identificador [não pode vir a ser alterado]; Extras esta propriedade permite guardar o projeto em um local diferente do local padrão utilizado pelo igrpweb. Assim alterando o valor do campo External? aparecerá o campo Host / Custom dad teremos um dos cenários descritos na tabela abaixo. Valor do campo External Custom dad Externo Valor do campo Host / Custom dad Nome do dad Vazio url de um local externo onde ficará Descrição Cria um ficheiro War a parte, ou seja outra instância do igrpweb Cria um ficheiro Jar das classes a parte, forra do war do igrpweb, no mesmo local Cria um ficheiro Jar das classes da aplicação guardado no local indicado pelo url Fig 5 3. A nossa aplicação aparecerá no painel do lado direito da Home - Page Builder [Fig 6], a partir de onde podemos executá-la ou aceder aos respetivos ficheiros pelo File editor. 6 P á g i n a
Fig 6 Home - Page Builder [aplicações criadas] 1.2 O File editor Acessível através do botão, na lista de aplicações do lado direito da Home - Page Builder [Fig 7], o File editor [Fig 8] é uma janela que nos dá acesso aos ficheiros da aplicação, nomeadamente classes e ficheiros de configuração, através de uma estrutura de pastas em forma de árvore no seu lado esquerdo. Qualquer alteração realizada em algum ficheiro deve ser valva pelo botão serão perdidas assim que a janela for fechada.. Caso contrário as alterações Fig 7 Home - Page Builder [botão File Editor] 7 P á g i n a
Fig 8 File Editor aspeto inicial. A imagem mostra o aspeto do File Editor de uma aplicação criada ainda sem páginas nem conexões. À medida em que formos desenvolvendo a aplicação, o conteúdo passará a estar disponível nesta página. O File Editor é a ferramenta que permite criar e alterar novos packages, classes e ficheiros de configuração da aplicação. Click com o botão direito do rato sobre cada item [ficheiro/pasta] no painel à esquerda exibe a lista de ações que podemos realizar sobre o mesmo. 1.3 Application Builder Qualquer alteração que queiramos realizar nas definições básicas de uma aplicação [definidas no formulário de criação da aplicação] é possível através da página Application Builder [Fig 9] a partir de onde podemos editar os dados da aplicação pelo botão, criar conexões de BD pelo botão, exportar aplicações [botão ], importar [botão ] e criar novas aplicações [botão ]. Fig 9 Application Builder 8 P á g i n a
OBS: quando atualizamos os dados de uma aplicação [Fig 10], se esta for desativada ficará indisponível e inacessível, logo o ficaremos impossibilitados de criar uma nova aplicação com o mesmo código. Fig 10 Application Builder [formulário de atualização das definições básicas de uma aplicações] 1.4 Criando páginas 1. Para criarmos páginas devemos primeiro criar a aplicação correspondente. Depois disso, vamos para o Home - Page Builder [Fig 11] [1], clicamos sobre o botão podemos criar uma nova página [Fig 12]. e será aberto um formulário onde Fig 11 - Home Page Builder [criando páginas] 9 P á g i n a
Fig 12 Page Builder [Novo] 2. Preenchemos o formulário da página sabendo que cada campo corresponde a: Title nome da página no layout [pode ser alterado posteriormente]; Code identificador único para cada página [não pode ser alterado posteriormente]; Enable para que seja possível a execução da página, e para que esteja presente na lista de páginas [alguns combobox, por exemplo] do ambiente de desenvolvimento; Publico permite que a página seja chamada por qualquer aplicação; Application obrigatório selecionar a aplicação a que a página pertence; Module pode organizar páginas relacionadas entre si no mesmo módulo. Não tem qualquer outro efeito na aplicação; Create menu cria um item de menu [ver o documento Gestão de acesso] para a página; Componente opção disponível apenas se Create menu estiver desativado, permite a criação de componentes padrão que podem ser importados de diversas páginas reduzindo a carga de trabalho do designer; Home Page página executada quando acessamos a aplicação. As páginas de cada aplicação são listadas na tabela da Home - Page Builder [Fig 13] [2] sempre que selecionarmos a aplicação correspondente [1]. 10 P á g i n a
Fig 13 Home - Page Builder [Lista de páginas por aplicação] Clicando sobre o botão [Gerar Código], abre-se o Gerador de Código, que abordamos no documento O Gerador de Código, destinado à construção da página. Os botões adjacentes permitem editar propriedades -, pré-visualizar - e exportar - cada página. Notemos que cada página criada fica disponível no File editor, correspondendo a um package com o mesmo nome [Fig 14] com três classes java [MVC], cujo funcionamento abordamos no documento Funcionamento de Páginas e Aplicações igrpweb. Fig 14 - File Editor [páginas criadas] 11 P á g i n a
2 CRIANDO CONEXÕES COM BASES DE DADOS Estando na Application Builder [Fig 10] ao clicarmos sobre o botão acessamos a página de conexões de Base de Dados [Fig 15] da nossa aplicação. Escolhendo o tipo de Base de Dados aparecerão novos campos [Fig 16] onde podemos configurar uma nova conexão e guardar através do botão. Fig 15 - Página de conexões de Base de dados Fig 16 - Configuração de conexão de Base de Dados 12 P á g i n a
Se a operação for realizada com sucesso a conexão criada aparecerá na tabela imediatamente abaixo, na mesma janela, [Fig 17] onde podemos fazer a sua edição / eliminação ou selecionar a conexão padrão através do choice. Fig 17 - Página de conexões de Base de Dados No caso temos apenas uma conexão, logo ela vem definida como padrão. A conexão padrão é utilizada sempre que fizermos acesso à base de dados sem especificar que conexão estamos a utilizar. Para cada conexão criada será criado um ficheiro xml [nome_da_conexao.nome_da_aplicação.cfg.xml], acessível pelo file editor [Fig 18] onde podemos fazer o mapeamento de classes na área assinalada, caso queiramos utilizar classes de um package dao. Fig 18 File Editor [acesso ao ficheiro de conexão] 13 P á g i n a
3 EXECUTANDO UMA APLICAÇÃO O local padrão para execução de aplicações é a página inicial do igrpweb [Fig 19], onde vemos todas a aplicações que nos pertencem e aquelas a que fomos convidados. Fig 19 - Página inicial do igrpweb Todavia, cada aplicação também pode ser executada a partir do painel do lado direito da Home - Page Builder [Fig 20], pelos utilizadores que nela ela tiverem privilégios de desenvolvedor. Fig 20 Home - Page Builder 14 P á g i n a
4 APLICAÇÕES SEM HOME PAGE DEFINIDA E PÁGINAS SEM CONTEÚDO Quando executamos uma aplicação sem uma Home Page definida veremos uma janela como a da Fig 21. Para resolver basta ir à Home Page Builder [Fig 13] e definir uma página como tal clicando sobre o botão correspondente e ativando a opção, na janela que se abrirá [Page Builder Atualizar]. Fig 21 - Execução de Aplicação sem Home Page Definida Do mesmo modo, quando tentamos executar uma página que foi criada [Criando páginas], mas cujo conteúdo não foi gerado, veremos uma página como a da Fig 22. Para resolver, devemos ir à Home - Page Builder [Fig 13] e gerar o código correspondente através do Gerador de Código, acessível através do botão [Gerar Código]. Mais informações a respeito no documento O Gerador de Código. Fig 22 - Erro na execução de página Obs: Outros tipos de erro na execução de páginas também podem levar-nos à página da Fig 22. 15 P á g i n a