Guia de instalação

14
GUIA DE INSTALAÇÃO v. 1.0.0

Transcript of Guia de instalação

GUIA DE INSTALAÇÃO v. 1.0.0

Desenvolvimento da aplicação e projeto

UNIVERSIDADE FEDERAL DE GOIÁS - UFGL3P - Laboratório de Políticas Públicas Participativas - FIC / UFG

UNIVERSIDADE FEDERAL DE SÃO CARLOS - UFSCarNúcleo de Estudos e Pesquisas em Tecnologia, Cultura e Sociedade - DCHE/UFSCar - campus Sorocaba

Coordenação GeralProf. Dalton Lopes Martins (UFG) - Profa Teresa Mary de C. Pires Melo (UFSCar)

Coordenação ExecutivaPaulo Pistili

DesenvolvimentoWillians Pedroso

Design e ArquiteturaEdvaldo de Goiás Pereira PontesRenato de Paula Mesquita

Elaboração do Manual do UsuárioPaulo PistiliWillians PedrosoTeresa MeloDalton MartinsCarla Hirata (Coletivo EntreLinhas)Mariana Kz (Coletivo EntreLinhas)Vítor Massao (Coletivo EntreLinhas)

SOROCABA/GOIÂNIA2015 / 2016

GUIA DE INSTALAÇÃOv. 1.0.0

Sumário

Introdução ............................................................................................................................7

Principais funcionalidades ..................................................................................................7

Por que o wordpress? .........................................................................................................8

Especificações técnicas .......................................................................................................8

Como as mensagens são enviadas e recebidas? ..............................................................9

Instalando o SMS Social ....................................................................................................11

Perfis de usuário ................................................................................................................12

Configurando o provedor de envio de mensagens ........................................................13

Personalizações fundamentais .........................................................................................13

Considerações finais .........................................................................................................14

Introdução

O SMS Social é uma ferramenta de gestão de grupos de contatos e envio de mensagens do tipo SMS. Tem como principal objetivo potencializar a relação entre determinada instituição e seu público a partir de um meio de comunicação acessível e personalizado. Com o enfoque principal na área social é uma ferramenta pensada para gestores e profissionais que trabalham com diferentes políticas públicas e que precisam de um veículo de comunicação direto com seu público.

Este documento é um guia prático de instalação e primeiros passos de configuração da ferramenta. Tem como objetivo auxiliar programadores e desenvolvedores a instalar e configurar a aplicação

Principais funcionalidades

l Envio e recebimento de mensagens SMS: para contatos individuais, bem como para grupos de usuários; l Gerenciamento de contas de usuários utilizadores do serviço; l Cadastro de grupos de contatos; l Cadastro de contatos; l Associação de contatos cadastrados a grupos de contatos; l Possibilidade de importação de planilha de contatos; l Criação de relatórios de envio e recebimento de mensagens de fácil exportação; l Integração com APIs de operadoras brasileiras para envio e recebimento de SMS.

Informações detalhadas sobre formas de uso podem ser lidas no Manual do Usuário, disponível no site: http://smssocial.gi.fic.ufg.br/

7

API significa Application Programming Interface ou, em português, Interface de Programação de Aplicativos. É o conjunto de padrões de programação para integração entre sistemas. O provedor do sistema de envio de mensagens fornece uma série de códigos de programação para que o SMS Social possa incorporar suas funções em sua programação. Para saber mais sobre APIs, acesse: https://pt.wikipedia.org/wiki/Interface_de_programação_de_aplicações

O SMS Social foi desenvolvido para ser utilizado a partir do software livre de gerenciamento de conteúdo web Wordpress, possibilitando à aplicação:

- ser um ferramenta acessível que funcione via internet; - ser disponibilizada gratuitamente; - ser personalizável; - permitir o aprimoramento pela comunidade de usuários e desenvolvedores Wordpress.

Por que o Wordpress?

O Wordpress é um potente gerenciador de conteúdo web que possibilita ao usuário desenvolver sites, blogs e portais. Fácil de usar, flexível e que possibilita a criação de projetos pequenos e simples a projetos mais complexos. Além disso, o Wordpress possibilita a instalação de uma vasta gama de plugins e temas que podem ser adicionados ao projeto e possui uma comunidade participativa na proposição de novas ferramentas, conteúdos e informação sobre o Wordpress.

Especificações técnicas

Foram utilizadas algumas tecnologias livres para o funcionamento da ferramenta:

l Linguagem de Programação PHP; l Linguagem de Script JavaScript; l Linguagem de Folhas de Estilos CSS; l Linguagem de Formatação HTML; l Banco de dados MySQL; l Wordpress.

Saiba mais em: https://wordpress.org/ e https://br.wordpress.com/

8

O SMSSocial segue os padrões adotados pela comunidade Wordpress, que podem ser conferidos no link: https://codex.wordpress.org/WordPress_Coding_Standard

Para o funcionamento da ferramenta, são necessários alguns pré-requisitos:

l Um domínio na web para utilizar a aplicação. Você pode utilizar um domínio que já possui ou criar um novo para o SMS Social.

IMPORTANTE: O SMS Social é um tema que assume o controle total do site, alterando todas as configurações e conteúdo previamente instalado. É importante que haja um domínio exclusivo para utilizar o SMS Social.

l Contratar um serviço de hospedagem para seu site ou utilizar um serviço já existente. l Instalar a versão mais recente do Wordpress e os softwares de programação web, como servidores, banco de dados e editores de código PHP. Vide referências do Wordpress codex: https://codex.wordpress.org/WordPress_Coding_Standard l Contratar um provedor de envio e recebimentos de mensagens.

Para esta primeira versão do SMS Social, configuramos o serviço de envio de mensagensda empresa Zenvia, visto sua confiabilidade em testes realizados durante o projeto. No entanto, nada impede que você contrate outro provedor e realize a integração do SMS Social com a API fornecida pela empresa. Neste caso, você precisará fazer modificações na estrutura do código de acordo com a API do provedor contratado.

O Plano de envio de mensagens de um provedor é um serviço cobrado pela empresa contratada e os valores variam dependendo do pacote escolhido.

Como as mensagens são enviadas e recebidas?

No modelo como enviamos nossas mensagens pelo celular a informação é transmitida da seguinte forma:

SMS Social Gateway Operadoras

9

Celular 1 Celular 2mensagem

enviadamensagem

recebida

Operadora 1 Operadora 2

Já com a utilização do SMS Social integrada a um provedor, a informação é transmitida da seguinte forma.

Funciona assim: após instalar o SMS Social, você entrará em contato com uma empresa de envio de SMS, este tipo de empresa é conhecida como provedor ou gateway. É uma espécie de portal que transmite a informação de um aparelho ou software para as operadoras de telefonia celular, que em seguida transmite a outro aparelho celular e vice-versa.

Assim como no envio de mensagens por nosso celular, este serviço tem um custo que varia de empresa para empresa. Entre em contato com o provedor e faça uma análise das possibilidades de contratação. Muita atenção neste momento, pois em alguns casos existem cobranças e planos diferentes quando se deseja apenas enviar mensagens pela ferramenta ou quando deseja enviar e receber mensagens.

O SMS Social está configurado para realizar ambas as operações, no entanto, a efetivação do serviço depende do plano contratado.

Lembramos que o SMS Social está configurado para o provedor da empresa Zenvia nesta primeira versão. Caso queira utilizar outro serviço, será necessário refazer a integração entre o SMS Social e o provedor.

O provedor deverá fornecer toda a documentação da integração com o SMS Social além do usuário e senha para acessar o serviço.

10

MensagemEnviada

MensagemRecebida noSMS Social

SMS Social OperadorasResposta

MensagemRecebida no

Celular

SMS Social Provedor Operadoras

Provedor

Instalando o SMS Social

Para instalar o SMS Social em seu painel Wordpress, basta buscá-lo na lista do diretório Wordpress ou procurar o arquivo .zip no diretório Git Hub. Os links para todas estas opções estão disponíveis no site: http://smssocial.gi.fic.ufg.br, no menu downloads.

Feito isso o SMSSocial assumirá todo o site e ficará instalado no seguinte caminho: wp-content/themes/smssocial

Dentro da raiz do smssocial, conterá os seguintes arquivos e diretórios:

Abaixo podemos visualizar os principais arquivos

• ajuda.php: Programa onde é inserido os links para ajuda do SMS Social. • controller.php: Arquivo para controlar para onde deve enviar os arquivos do menu. • fale_conosco.php Programa com formulário de contato para disparar email. • footer.php Rodapé do tema. • functions.php Padrão do Wordpress para todas as funções que o tema irá utilizar. • header.php Cabeçalho do SMS Social. • index.php Página principal, onde irá direcionar todas as páginas. • install.php Programa com as querys de criação das tabelas do SMS Social. • menu.php Programa que insere o menu no tema do SMS Social, fazer validações de login pelo perfil do usuário ativo. • sidebar.php Arquivo padrão do Wordpress. • sobre.php Arquivo onde irá conter o texto sobre o SMS Social. • style.css Arquivo padrão do Wordpress para os temas desenvolvidos e importar as folhas de estilos.

11

Perfis de usuário

A aplicação está vinculada às configurações do painel principal do Wordpress. Ao instalar o Wordpress, o administrador do site em que o SMS Social está instalado poderá definir contas para cada usuário. Existem três níveis de usuários para a aplicação:

l Se você fará a instalação e administração do site Wordpress de sua instituição: ADMINISTRADOR WORDPRESS.

- Tem acesso total a todas as funções do sistema.

l Se você irá cadastrar e gerenciar funcionários e gestores de determinada instituição que utilizarão a ferramenta e precisa visualizar as mensagens enviadas e recebidas, ver contatos, gerar relatórios e escolher o provedor: ADMINISTRADOR.

- Tem acesso a todas as funções do sistema, exceto ao painel de configurações do Wordpress.

l Se você é responsável por gerenciar contatos, criar grupos, enviar mensagens e extrair relatórios: GESTOR.

- Tem acesso a todas as funções do sistema, exceto funções administrativas, como por exemplo, escolher um provedor ou gerenciar contas de usuários.

Cada perfil de usuário está vinculado a uma instituição. No momento em que um usuário está vinculado a uma instituição, ele só poderá visualizar as informações dessa instituição. Caso queira visualizar outras instituições, precisará alterar isso em seu cadastro.

Portanto, para iniciar a utilização do sistema, o administrador do site Wordpress precisa fornecer um usuário e senha de administrador para que a ferramenta possa ser utilizada.

12

Configurando o provedor de envio de mensagens

É possível configurar o provedor de envio de mensagens pelo menu admin do SMS Social.

Acesse: Admin > Provedor > selecione o provedor cadastrado > insira usuário e senha fornecidos pelo provedor.

Personalizações fundamentais

Após instalada a aplicação, você pode fazer as personalizações que deseja no SMS Social a partir do usuário Admin-WP e com um pouco de conhecimento em programação:

l alterar o logotipo

Cabeçalho do SMS Social. index.php

l configurar o e-mail da tela fale conosco. Sugerimos que a tela fale conosco seja configurada para o e-mail do administrador geral da aplicação.

fale_conosco.php Programa com formulário de contato para disparar email.

É importante que no PHP do servidor em que aplicação está instalada esteja configurado o SMTP para disparar e-mails.

Esta função serve como canal de comunicação entre o administrador wordpress e os demais usuários da ferramenta.

13

Considerações finais

Este Guia de Instalação e Configurações Básicas apresenta algumas ações fundamentais para o funcionamento da ferramenta, no entanto, personalizações mais específicas podem ser feitas na aplicação. Nesta primeira versão da aplicação trabalhamos com funcionalidades que já permitem um uso complexo de operações. Novas pesquisas estão sendo feitas para aprimorar a aplicação e desenvolver novos caminhos e tecnologias.

14

Para maiores informações: http://smssocial.gi.fic.ufg.br/