Maker Planet Manual do Usuário

Transcrição

1 Maker Planet Manual do Usuário Atenção: Este é o rascunho inicial deste documento, visite o Maker Planet.COM ( para obter as atualizações deste documento. Arquivo gerado na terça-feira, 26 de maio de 2009 Autor: Lourival Oliveira da Silva lourival@makerplanet.com Versão: Rascunho

2 Conteúdo Guia Rápido... 4 Publicando uma aplicação feita em Maker 2 na Web... 5 Dados de acesso... 5 Acessando o Painel de Controle... 5 Introdução ao Painel de Controle... 5 Fazendo Upload de sua aplicação... 6 Histórico de uso de memória... 6 Importação do FRZ (Experimental)... 7 Opções avançadas... 7 Webrun visual settings... 7 Webrun advanced settings... 8 DNS Integration... 8 Webrun version and temp files... 9 Protegendo o código fonte... 9 Como remover o código fonte do JAR Administração do Banco de dados Criando um novo banco de dados Fazendo o backup Enviando um backup para o servidor Upload do backup via FTP Copiando o backup do servidor Restaurando um backup Excluindo um banco de dados Mais ferramentas administrativas Criando as tabelas FR do Maker Tabelas utilizadas após a geração de código Otimizando sua aplicação para web Reduzindo o consumo de memória Reduza o número de aplicações publicadas Limitando a quantidade de registros consultados Reduzindo o número de listas dinâmicas (lookups) Reduzindo o tráfego de rede Aumentado a segurança

3 Acompanhando suas faturas Integração com websites Tela de login personalizada Redirecionando subdomínios para uma aplicação específica Anexo I - Configurando o servidor DNS no Parallels Plesk Control Panel Anexo II Pagamento via PagSeguro UOL

4 Guia Rápido Veja como publicar uma aplicação rapidamente no Maker Planet. 1. Gere o código fonte da aplicação que será publicada no formato JAR; 2. Mude o nome do JAR para que tenha o mesmo nome do WFRE do projeto (ex: Sistema de Exemplo.jar e Sistema de Exemplo.wfre ); 3. Acesse o Maker Planet e faça login no Painel de Controle; 4. Faça upload do JAR e do WFRE na seção Maker Applications (primeira aba); Crie o banco de dados remotamente usando um dos métodos abaixo: a. Usando um backup do banco de dados: i. Faça um backup do banco de dados da aplicação; ii. Faça o upload do Backup do backup do banco de dados; iii. Restaure o backup remotamente; b. Usando o script para criação das tabelas: i. Crie uma nova base de dados usando o Painel de Controle; ii. Acesse o banco usando uma das ferramentas administrativas disponíveis no site; iii. Execute o script de criação do banco de dados; 5. Inicie o seu servidor de aplicação; 6. Acesse o sistema e faça as configurações necessárias no WFRE a. Defina o login e senha do banco; b. Defina o nome do host e a porta do servidor; 4

5 Publicando uma aplicação feita em Maker 2 na Web Este tópico descreve como utilizar o Maker Planet para publicar suas aplicações feitas em Maker 2 na Web. Dados de acesso Após a confirmação do seu cadastro no Maker Planet você receberá um com os dados de sua conta de usuário e senha. Serão entregues duas senhas, uma para sua conta pessoal e outra para as atividades do sistema como FTP e banco de dados. Acessando o Painel de Controle No site do Maker Planet você deve clicar sobre o link do Painel de Controle, será exibida a tela de login, use os dados recebidos para acessar sua conta. Introdução ao Painel de Controle O Painel de Controle é uma aplicação Maker que permite que você administre as aplicações publicadas na Maker Planet. Além de controlar detalhes técnicos do seu sistema, você também pode acompanhar as faturas. Relação de contratos de hospedagem ativos, administração do tomcat e atualização das aplicações Faturas emitidas e pagamento de faturas 5

6 Fazendo Upload de sua aplicação O primeiro passo é gerar o JAR com a aplicação compilada em seu ambiente de desenvolvimento. Veja como gerar o JAR nos seguintes tópicos do Manual do Maker 2: exportar_codigo_jar.htm Agora basta clicar no botão Upload, o arquivo será adicionado à pasta systems do Webrun. Somente arquivos JAR e WFRE podem ser adicionados aqui. Após adicionar um JAR você deve reiniciar o Tomcat para que a aplicação seja atualizada. Histórico de uso de memória Este gráfico permite acompanhar o uso de memória de sua aplicação ao longo dos últimos dias. Você também pode consultar o relatório detalhado contendo os dados dos últimos dias de sua aplicação. É importante acompanhar o uso de memória para evitar que falte memória para sua aplicação devido ao aumento de carga após a implantação. No relatório você também poderá observar o 6

7 número de acessos (sessões de usuários) durante o dia, verificando a relação entre a quantidade de usuários e o consumo de memória. Importação do FRZ (Experimental) Através desta interface é possível atualizar sua aplicação rapidamente, se valendo dos recursos de exportação/importação do Maker (FRZ). Opções avançadas Webrun visual settings Esta seção permite definir detalhes da aparência do seu Webrun. Custom background Utilize para especificar a imagem de fundo do Webrun na tela de seleção do sistema. 7

8 Custom login image Utilize para redefinir a imagem que aparece no banner da tela de login. Webrun advanced settings Aqui estão listadas algumas opções de configuração do Webrun que você deve dedicar alguma atenção. Optimize to internet O Webrun por padrão transfere muito mais código para a camada cliente do que o normalmente necessário, isso ocorre porque ele vem configurado para o ambiente de Intranet onde é aceitável tal desperdício devido aos benefícios que ele pode oferecer. Porém você pode melhorar significativamente a performance de suas aplicações. Consulte o manual do Webrun para saber as implicações de tal recurso. Enable Task Schudeler Ativa o agendador de tarefas do Webrun, sem essa opção os fluxos agendados não irão executar, caso não tenha nenhum fluxo agendado desative tal opção para poupar recursos. Debug mode Ative somente quando estiver encontrando problemas em sua aplicação e deseja mais detalhes sobre o erro, desative assim que solucionar o problema. Rule timeout Determina o tempo máximo de execução dos fluxos. Coloque o menor valor possível pois se o fluxo demorar muito provavelmente há um erro de programação que pode estar desperdiçando os recursos do servidor. DNS Integration Permite especificar uma URL alternativa para acesso a sua aplicação, aqui você informará a URL que o cliente irá utilizar sem o HTTP, por exemplo: apps.meusite.com.br. Para adicionar mais de uma URL use um espaço como separador. Depois você deve configurar o seu servidor DNS para redirecionar as requisições para a conta nos servidores do Maker Planet através de um registro CNAME. Para tal adicione um registro CNAME ao seu servidor DNS que irá redirecionar um subdomínio (neste exemplo apps) do seu site para os servidores do MakerPlanet, por exemplo para que seus clientes acessem os seus sistemas através da URL e sejam redirecionados para basta adicionar o seguinte registro no seu DNS: Tipo: CNAME Origem: apps Destino: minhaconta.makerplanet.com Há um período para atualização do DNS, após algum tempo (< 4h) o redirecionamento do seu site começará a funcionar e você será redirecionado para o MakerPlanet, que também tem um período para atualização das URL s alternativas (24h-72h), enquanto esta atualização não for efetuada você verá o site do Maker Planet. 8

9 Usando o DNS dos servidores do MakerPlanet Caso você ainda não tenha um DNS para o seu domínio, ou ele somente será usado para a aplicação você poderá utilizar o Name Servers do Maker Planet, para tal adicione os seguintes servidores como Name Servers no registro no seu domínio: Name Server 1 Nome: ns1.makerplanet.com.br IP: Name Server 2 Nome: ns2.makerplanet.com.br IP: Webrun version and temp files Utilize para controlar a versão do Webrun e Gerador de relatórios utilizado. Webrun version Aqui você pode especificar qual versão do Webrun será utilizada em sua aplicação, você pode alterar a versão utilizada a qualquer momento, mas antes é necessário parar o Tomcat. Republish Use este comando para limpar o context do Webrun, a pasta work será apagada, e o WAR do Webrun será republicado apagando qualquer alteração na pasta do Webrun restaurando-o para o estado original. Maker Reports Esta opção permite substituir a versão do gerador de relatórios em uso no seu Webrun, é recomendável parar o Tomcar antes de trocar a versão para evitar que algum relatório em execução impeça a conclusão da tarefa. HTTP, HTTPS e Client Authentication Permite configurar o acesso via HTTPS, HTTP e autenticação da máquina cliente. Autenticação da máquina do cliente Este recurso restringe o acesso ao sistema somente através de computadores com um certificado SSL instalado, ou seja, somente os computadores em que você adicionar o certificado terão acesso ao sistema, esta opção desabilita o acesso via HTTP. Protegendo o código fonte Não é necessário fazer UPLOAD das tabelas FR que contém os códigos fontes do seu sistema, no Maker Planet você pode trabalhar com o JAR, que é a versão compilada de sua aplicação. Um aspecto que devemos observar quando trabalhamos com o JAR é que ele contém tanto o sistema compilado (bytecode), quanto o código fonte em Java (*.java), ou seja, é possível editar seu sistema, ou observar detalhes do funcionamento através dos códigos das classes em Java. Para evitar tal situação basta remover os códigos fonte do arquivo JAR. 9

10 Como remover o código fonte do JAR Ao exportar sua aplicação para um arquivo JAR o código fonte em Java é adicionado ao JAR também, caso não seja interessante para o seu negócio você pode remover os fontes em Java do JAR deixando somente as classes compiladas. Para remover os fontes em Java abra o arquivo JAR com uma ferramenta compatível com ZIP (WINRAR ou WINZIP - por exemplo), localize a pasta `src na raiz do zip e delete-a. Isso removerá todos os fontes em JAVA contido no JAR gerado pelo Webrun. 10

11 Administração do Banco de dados Este tópico cobre a administração dos seus bancos de dados nos servidores. A interface web fornece as funcionalidades principais para publicação e manutenção de uma aplicação Maker. Criando um novo banco de dados A interface administrativa permite criar novos bancos de dados remotamente. Fazendo o backup Para iniciar um backup selecione um banco de dados e clique sobre o botão Make a backup now, o backup será listado na aba Backups onde poderá ser baixado, restaurado ou excluído. 11

12 Enviando um backup para o servidor Cada backup deve ser enviado usando o botão correspondente ao DBMS. Upload do backup via FTP Quando o backup for muito grande você pode fazer o upload via FTP, para tal acesse o ftp.makerplanet.com usando um cliente FTP como WINSCP ( ou o próprio FTP disponível no prompt de comando do Windows. Após conectar-se via FTP você deve acessar a pasta de backups de banco de dados \backups\databases agora basta fazer o upload do arquivo. Ao fazer upload certifique-se de que os backups tenham a extensão padrão correspondente ao banco, no MakerPlanet convencionamos o seguinte: PostgreSQL - *.backup MS SQL Server - *.bak MySQL - *.sql 12

13 Após fazer o upload do arquivo use o botão Refresh para que os novos arquivos sejam reconhecidos pela interface administrativa e então você poderá utilizá-los para um restore. Exemplo de upload de backup usando o FTP do Windows C:\>ftp ftp.makerplanet.com Connected to ftp.makerplanet.com. 220 Wellcome to MakerPlanet FTP User (ftp.makerplanet.com:(none)): login 331 Password required for Password: ***** 230 User login logged in. ftp>cd backups\databases 250 CWD command successful. "/backups/databases" is current directory. ftp>lcd c:\meusbackups\ Local directory now c:\meusbackups\ ftp>binary 200 Type set to I. ftp>put meusistema.backup OBS: O comando binary especifica que o arquivo sendo transmitido não é um texto, se for omitido pode causar erros na transmissão. Copiando o backup do servidor Você pode fazer o download do backup através da interface administrativa usando sua conta FTP. 13

14 Restaurando um backup Maker Planet - Manual do usuário Ao selecionar um backup para ser restaurado você pode definir se ele será efetuado sobre um banco de dados existente ou um novo banco de dados. Se for um novo banco de dados informe o nome e o Charset/Collation do banco de dados que será criado. Excluindo um banco de dados Basta selecionar um banco de dados e clicar sobre o botão Drop Database, pare o tomcat antes de tentar remover um banco de dados para certificar-se de que não haja nenhuma conexão ativa com o BD que está sendo excluído. Se o banco de dados não for excluído verifique o log para determinar a causa. Mais ferramentas administrativas Além da interface do Painel de Controle o Maker Planet oferece três outras ferramentas administrativas especificas para cada banco de dados suportado, são elas: 14

15 phppgadmin PostgreSQL - phpmyadmin MySQL Web Data Administrator MS-SQL Server Criando as tabelas FR do Maker Ao se publicar uma aplicação Maker devem ser mantidas algumas tabelas no banco de dados de produção, de acordo com o tipo de publicação e dos recursos desejados essa lista de tabelas pode se modificar. Tabelas utilizadas após a geração de código Ao publicar sua aplicação você precisará criar as tabelas abaixo no banco de dados. As tabelas do Agendador de tarefas são opcionais. Tabelas necessárias para a publicação das aplicações com JAR ou WAR FR_SISTEMA FR_USUARIO FR_GRUPO Controle de acesso FR_USUARIO_GRUPO FR_USUARIO_SISTEMA FR_PERMISSAO FR_LOG Log de atividades FR_LOG_EVENT FR_RELATORIO Gerador de relatórios Agendador de tarefas Identificação do usuário no SGDB FR_TAREFA FR_TAREFA_TEMPO FR_REGRAS FR_SESSAO FR_SESSAO_VI Relatórios do sistema (desnecessário a partir da versão ) 15

16 Otimizando sua aplicação para web Uma aplicação web precisa ser executada com melhor utilização dos recursos, já que há diversas limitações impostas pelo cenário atual da internet, especialmente no Brasil. O Webrun é um aplicativo suficientemente versátil para atender à uma Intranet, assim como a publicações na Internet. Mas ao usarmos essa abordagem devemos ter alguns pontos em mente. Reduzindo o consumo de memória A memória que o Webrun consome pode aumentar consideravelmente quando se deixa de lado alguns detalhes na construção do seu software. Reduza o número de aplicações publicadas Cada aplicação publicada consome recursos que poderiam ser economizados publicando o software em um único aplicativo separado em módulos. Ou seja, se você tem um módulo financeiro, e outro administrativo separe-os em módulos de um mesmo programa, e use os recursos de permissão para exibir/ocultar os recursos que cada usuário tem acesso. Limitando a quantidade de registros consultados Uma base de dados pode crescer rapidamente após a implantação, ou seja, consultas que inicialmente retornavam poucas dezenas de registros podem com o passar do tempo retorna milhares ou mesmo milhões de registros, para evitar que o consumo de memória suba com o tempo use limitadores de SELECT (TOP/LIMIT/FIRST) para determinar a quantidade máxima de registros que as consultas irão retornar, assim formulários e listas dinâmicas não carregarão mais registros do que um valor razoável (< 200). Reduzindo o número de listas dinâmicas (lookups) Não utilize listas dinâmicas para exibir valores que podem vir no SELECT do formulário, ou seja, se você tem uma tela para consultar o histórico escolar de um aluno, por exemplo, o nome do curso e do professor não precisam ser listas dinâmicas, pode-se adicionar um JOIN ao SELECT e trazer esses dados mais rapidamente usando menos consultas ao banco de dados. Tente reduzir o número de listas dinâmicas (lookups) ao estritamente necessário. Reduzindo o tráfego de rede Há alguns parâmetros que fazem com que seu aplicativo somente envie para os clientes (browsers) as regras em uso de cada tela, assim como os componentes (lookup, edit, grid,...) usados em cada tela reduzindo assim o tráfego de rede, além do processamento necessário para carga do aplicativo. Aumentado a segurança Quando uma aplicação é publicada na web sua visibilidade aumenta, consequentemente devemos nos preocupar mais com a segurança da aplicação. Há parâmetros de configuração que reforçam a segurança como, por exemplo: Seguranca:Permissao:RemoverCamposInvisiveis Não envia para o cliente/navegador os campos invisíveis. RestringirAcessoAdministrativo Remove o link de acesso a interface adminitrativa do Webrun. 16

17 Acompanhando suas faturas Dez dias antes do vencimento de sua mensalidade a fatura correspondente estará acessível no Painel de Controle. A fatura pode ser paga através do PagSeguro UOL, ou através do PayPal. 17

18 Integração com websites As aplicações hospedadas nos servidores do Maker Planet podem ser integradas com seu website de diferentes formas, a primeira alternativa consiste em usar uma tela de login personalizada no website que já redireciona para a aplicação desejada, ou usar diferentes URLs para apontar para diferentes sistemas, observe as duas abordagens abaixo. Tela de login personalizada Para personalizar tela de login dê uma olhada neste artigo na Wiki da Softwell: Redirecionando subdomínios para uma aplicação específica É possível definir múltiplos domínios apontando para uma única conta no Maker Planet, por exemplo: demonstration.makerplanet.com e demo.makerplanet.com são definidos como aliases para a mesma conta, este recurso pode ser estendido para que cada URL seja direcionada para uma aplicação específica, para tal é necessário a edição do arquivo index.jsp, que se encontra na raiz do Webrun. O objetivo deste código é lê a URL de origem da requisição (request) e comparar com os itens da lista, se tiver um sistema correspondente a requisição é redirecionada para o sistema, exibindo a tela de login. No exemplo hipotético abaixo se a requisição vier de demo1.makerplanet.com o sistema com a sigla SGP é aberto, se vier de demo2.makerplanet.com irá para o sistema TER. Quando for utilizar sistemas com a mesma sigla use o recurso de nome de instância e passe o nome da instância junto com o nome do sistema, por exemplo, se houvesse um sistema com a sigla MPL e duas instâncias desse sistema chamadas MATRIZ e FILIAL, o sys ficaria com MPL_MATRIZ e MPL_FILIAL respectivamente. index.jsp --INICIO DO ARQUIVO <% %> String targeturl = ""; String URL = request.getservername(); if (URL.equals("demo1.makerplanet.com ")) targeturl = "/logon.jsp?sys=sgp"; if (URL.equals("demo2.makerplanet.com")) targeturl = "/logon.jsp?sys=tre"; if (URL.equals("demo3.makerplanet.com")) targeturl = "/logon.jsp?sys=mpl_matriz"; if (URL.equals("demo4.makerplanet.com")) targeturl = "/logon.jsp?sys=mpl_filial"; response.setstatus(301); response.setheader( "Location", targeturl ); response.setheader( "Connection", "close" ); --FIM DO ARQUIVO Lembre-se de colocar o arquivo index.jsp dentro do Maker.Commons para evitar que o código se perca durante uma atualização do Webrun. 18

19 Anexo I - Configurando o servidor DNS no Parallels Plesk Control Panel Alguns provedores de hospedagem usam o Plesk como interface administrativa, esta interface permite a configuração do DNS diretamente pelo cliente, se esta opção estiver liberada pelo seu provedor, caso não esteja entre em contato com o seu provedor para obter alternativas. Caso esteja selecione o domínio que deseja integrar, neste exemplo vamos usar como exemplo a URL lourival.eti.br, localize o e clique sobre o ícone DNS Settings. Será exibida a lista de entradas existentes no DNS e um botão para adicionar novos registros Add Record. Clique sobre este botão para que seja exibida a interface de cadastro de novos registros. Selecione o tipo de registro, que deve ser CNAME, no próximo campo você deve informar o nome do subdomínio que será redirecionado, neste exemplo apps, e por fim a URL da conta no MakerPlanet sem o HTTP, algo do tipo minhaconta.makerplanet.com. Basta clicar em OK e aplicar as alterações. 19

20 Anexo II Pagamento via PagSeguro UOL 1. Façao o Login no Painel de Controle: 2. Clique sobre o botão... da fatura exibida na grade inferior da sua tela inicial no Painel de Controle; 3. Será exibido uma tela com os detalhes da fatura, utilize o botão Make this payment using PagSeguro para ser redirecionado para o site do PagSeguro UOL; 20

21 4. Neste ponto você estará no site da UOL, siga as informações oferecidas pelo sistema, é possível efetuar o pagamento usando boleto, cartão de crédito, depósito em conta, entre diversos outros; 5. Observe a barra de endereço ou o cadeado indicando que este é um site seguro, essa é a garantia de que você está no local correto; 21