Sistema de Cadastro e Controle de Leis Desenvolvido por Fábrica de Software Coordenação de Tecnologia da Informação Pág 1/22
Módulo: 1 Responsável: Desenvolvimento Ti Data: 01/11/2012 Versão: 1.0 Empresa: Prefeitura Municipal de Cachoeirinha-RS Histórico de Revisões Manual de Software Data Versão 01/11/12 1 Manual do Sistema Leandro Furini 11/06/13 2 Manual do Sistema Leandro Furini Descrição Autor Pág 2/22
Sumário 1. Manual...4 1.1 Login...4 1.2 Tela Principal do Sistema...6 1.3 Cadastros e Consultas...6 1.3.1 Cadastro de Usuários...6 1.3.1.1 Novo Usuário...8 1.3.1.2 Editar Usuário...8 1.3.1.3 Excluir Usuário...8 1.3.2 Cadastro de Legislação...8 1.3.2.1 Nova Legislação...9 1) Inserir Referências a outras Legislações Links...10 2) Inserir Anexos Cadastrados no Sistema...12 3) Inserir Anexos Externos (não estão cadastrados no sistema)...13 1.3.2.2 Editar Legislação...15 1.3.2.3 Excluir Legislação...15 1.3.2.4 Inserir Imagem em uma Legislação...15 1.3.3 Cadastro de Legislação em Destaque...18 1.3.3.1 Inserção de nova legislação em destaque...19 1.3.3.2 Editar legislação em destaque...20 1.3.3.3 Excluir legislação em destaque...20 1.3.4 Cadastro de Anexo...20 1.3.4.1 Novo Anexo...21 1.3.4.2 Editar Anexo...21 1.3.4.3 Excluir Anexo...21 1.3.5 Formatação extra para a Ementa...22 Pág 3/22
1. Manual Este manual tem o objetivo de demonstrar o funcionamento do Sistema. Com a intenção de oferecer a compreensão do Sistema e mostrar as suas funcionalidades, explicando o que cada janela de interface oferece para o usuário. Neste manual serão expostas imagens reais das telas do Sistema, para que os usuários visualizem os componentes da tela e possam entender as suas funcionalidades. Nesta seção será mostrado questões a cerca de nível de acesso, segurança, prioridades, hierarquia e procedimentos relacionados ao sistema. O principal objetivo deste sistema é o cadastro das legislações e o seu gerenciamento. Níveis de acesso No sistema haverá dois (2) níveis de acesso ao sistema. Os níveis terão acesso restrito ao sistema, são eles: Perfil Administrador e Perfil Básico. Segurança Dados não serão excluídos nem alterados sem que o usuário tenha plena consciência. Essa segurança é dada por comandos INDIVIDUALIZADOS para cada ação, e necessitam de confirmação para sua realização, caso o usuário clique em um destes botões por descuido uma mensagem de confirmação da ação será exibida para que seja confirmada a execução do comando, desta forma o usuário poderá cancelar a ação, não executando nenhuma alteração ou exclusão. Hierarquia Há uma hierarquia de acesso organizada em dois níveis: Nível 1 - Perfil Administrador e Nível 2 - Perfil Básico. Prioridade Para alguns cadastros que necessitem de dados já cadastrados no banco de dados, estes terão que ser cadastrados anteriormente, para poderem ser visualizados e utilizados. Exemplificando, para que uma legislação recebe anexos, estes já deverão estar cadastrados para que se possa fazer o seu link com a legislação. 1.1 Login O acesso ao programa se fará mediante uma tela de login, onde esta exibirá dois campos a serem preenchidos o Usuário e Senha, ambos previamente cadastrados. O usuário que deverá ser utilizado no acesso ao sistema será o CPF informado no momento do cadastro do usuário, bem como a senha cadastrada. Pág 4/22
Abaixo se visualiza a tela de login, característica do acesso ao sistema, após ser acionado o endereço do programa: Caso os dados digitados estejam incorretos ou o usuário não seja cadastrado, o login não permitirá acesso ao sistema, retornando para a tela de login, fazendo a limpeza dos campos. Desta forma, digitar-se-á novamente as informações ou será solicitado à pessoa responsável do departamento pela administração do sistema para realizar o cadastro deste usuário com login e senha para que este tenha acesso ao sistema. Para cadastro de usuário ver item 1.3.1. Pág 5/22
1.2 Tela Principal do Sistema Após realizar o login, o usuário será direcionado para a tela principal onde terá o seguinte visual: Na tela inicial do sistema serão mostradas as legislações que ficarão em evidência para o usuário final (população), sendo visualizada sempre que o sistema é iniciado ou o operador efetue alguma ação que se encerre. 1.3 Cadastros e Consultas Neste item serão mostrados as telas das funções do Sistema. 1.3.1 Cadastro de Usuários A abertura da tela de cadastro de usuários poderá ser realizada pelo menu de acesso na tela principal do sistema. Só estão autorizados a cadastrar usuários operadores com nível de acesso de Administrador. Pág 6/22
Ver imagem de acesso. Menu de acesso ao Cadastro de Usuários Após seleção do meio de acesso será aberta a seguinte tela de cadastro: Cadastro de usuários Pág 7/22
1.3.1.1 Novo Usuário Para o cadastro de um novo usuário faz-se a seleção do Link Usuários na aba CADASTROS, preenchendo o formulário com os seguintes dados: Nome, e-mail, CPF/Login, senha, repita senha, permissão de cadastro de novos usuários. Após a inserção dos dados, deve-se selecionar o botão SALVAR sendo exibida a seguinte mensagem: Seus dados foram inseridos com sucesso!, gravando o novo Usuário. 1.3.1.2 Editar Usuário Para a edição de um usuário deve-se consultar a lista de usuários no menu Cadastro no item Usuários, onde será gerada uma lista com os nomes dos usuários do sistema. Para alteração de algum dado clica-se no link Editar, sendo aberta um página com os dados cadastrados, onde poderá ser realizada a alteração, após clicar no botão Alterar Usuário para que os novos dados sejam gravados. Não será possível alterar o CPF do usuário já cadastrado, uma vez que este é validado no momento do cadastro, não sendo desta forma possível a inserção de um CPF inválido, não necessitando assim alteração desta informação. 1.3.1.3 Excluir Usuário Não haverá a exclusão do usuário, este poderá ser colocado em uma situação de inatividade. Para isso basta realizar a edição dos dados deste usuário e marcar a opção Ativo como NÃO, desta forma o usuário não poderá realizar login no sistema. 1.3.2 Cadastro de Legislação A abertura da tela de cadastro de legislação poderá ser realizada pelo menu na tela principal do sistema. Ver imagem de acesso. Menu de acesso ao Cadastro de Legislação Pág 8/22
Após o menu ser acionado será aberta a seguinte tela de cadastro: Cadastro de Legislação 1.3.2.1 Nova Legislação Para o cadastro de uma nova legislação faz-se a seleção do Link Legislação na aba CADASTROS, submenu Inclusão. Após faz-se o preenchendo do formulário com os seguintes dados: Tipo de Legislação (LEI, LEI COMPLEMENTAR ou DECRETO), Número da Legislação, Nome da Legislação, Data da Publicação, Ano, Status (EM VIGOR ou REVOGADA), Ementa e Corpo da Legislação (realizar a cópia integral da lei e realizar a cola sem necessidade de realizar formatações adicionais, apenas inserir links). Após a inserção dos dados, deve-se selecionar o botão SALVAR LEGISLAÇÃO, sendo emitido a seguinte mensagem: Seus dados foram inseridos com sucesso!, para assim gravar a nova legislação. Pág 9/22
1) Inserir Referências a outras Legislações - Links Para a inserção de referências dentro do corpo da legislação a outras legislações seguir seguintes passos: a) Colar o texto da legislação no campo Corpo da Legislação; b) Selecionar a parte do texto que faz referência a outra legislação e clicar em Inserir/Editar Link, conforme imagem abaixo: c) Na tela que abrirá setar as seguintes configurações com o padrão aqui especificado, caso esteja diferente da necessidade. 1) Tipo de Hiperlink: URL; 2) Protocolo: <outro>; 3) URL: buscalegis.php?tipolegis=l&numlegis=44444 Aqui em URL digitar todo o texto referenciado, mudando apenas o que está em negrito. Utilizar como padrão as letras L para Lei, LC para Lei Complementar e D para Decreto, o número requerido é o da própria legislação, igual ao número cadastrado para ela, se houver alguma / (barra) ou outro caracter diferente no nome da lei, este, também deverá ser utilizado aqui, caso contrário a referência não encontrará a legislação referida. IMPORTANTE as letras utilizadas L, LC ou D deverão ser SEMPRE MAIÚSCULAS. Pág 10/22
Após a inserção dos requisitos se terá uma tela parecida com este modelo: d) Estando os dados no padrão, clica-se no botão OK, gerando a referência no texto selecionado, ficando azul e sublinhado. Pág 11/22
2) Inserir Anexos Cadastrados no Sistema Para a inserção de um anexo a uma lei, este já deverá estar cadastrado, (cadastro de anexo ver item 1.3.4). Para a inserção de referências de anexo dentro do corpo da legislação, seguir seguintes passos: a) Selecionar a parte do texto que faz referência ao anexo e clicar em Inserir/Editar Link, conforme imagem abaixo: b) Na tela que abrirá setar as seguintes configurações com o padrão aqui especificado, caso esteja diferente da necessidade. 1) Tipo de Hiperlink: URL; 2) Protocolo: <outro>; 3) URL: buscanexo.php?tipolegis=l&numlegis=44444&nome=anexo 1 Aqui em URL digitar todo o texto referenciado, mudando apenas o que está em negrito. Utilizar como padrão as letras L para Lei, LC para Lei Complementar e D para Decreto, o número requerido é o da própria legislação, igual ao número cadastrado para ela, se houver alguma / (barra) ou outro caracter diferente no nome da lei, este, também deverá ser utilizado aqui, caso contrário a referência não encontrará a legislação referida, bem como no nome do anexo, onde deverá ser colocado exatamente como o cadastrado, caso contrário não será encontrado. IMPORTANTE as letras utilizadas L, LC ou D deverão ser SEMPRE MAIÚSCULAS. Pág 12/22
Após a inserção dos requisitos se terá uma tela parecida com este modelo: c) Estando os dados no padrão, clica-se no botão OK, gerando a referência no texto selecionado, ficando azul e sublinhado. 3) Inserir Link de Anexos Externos (não estão cadastrados no sistema) Para esta etapa se deve entender que anexos externos são considerados TODO e qualquer arquivo que não esteja cadastrado via sistema de anexos. Nesta modalidade de anexo será aceito qualquer arquivo de qualquer extensão (cdr, bitmap, jpg, jpeg, pdf, img etc.). Pág 13/22
Para a inserção de referências de anexo externo, seguir os seguintes passos: a) Selecionar a parte do texto que faz referência ao anexo e clicar em Inserir/Editar Link, conforme imagem abaixo: b) Na tela que abrirá setar as seguintes configurações com o padrão aqui especificado, caso esteja diferente da necessidade. 1) Tipo de Hiperlink: URL; 2) Protocolo: <outro>; 3) URL:../sislegis/nomearquivo.extensão Aqui em URL digitar os dois pontos (..), barra (/), sislegis (nome da pasta onde estarão os anexos externos), barra(/), nome do arquivo (sem espaços em branco) ponto (.) a extensão do arquivo (aqui pode ser como exemplo jpeg, jpg, bitmap, cdr, xlsx,docx, pdf etc.), caso não exista o ponto, a extensão do arquivo, o nome esteja errado, ou exista espaço em branco no nome, este arquivo não será encontrado e não será ser exibido, apresentando erro. Após a inserção dos requisitos se terá uma tela parecida com este modelo: Pág 14/22
c) Para que o anexo não abra dentro do site fazendo com que o menu desapareça, deve-se seguir o seguinte: Na inclusão do link do arquivo clicar em Destino e selecionar Nova Janela(_blank), ver imagem de exemplo: d) Estando os dados no padrão, clica-se no botão OK, gerando a referência no texto selecionado, ficando azul e sublinhado. 1.3.2.2 Editar Legislação Para a edição de uma Legislação deve-se consultar a lista de legislações no menu Cadastro no item Pesquisa/Alteração, onde será gerada uma lista com os nomes das legislações cadastradas no sistema. Para alteração de algum dado clica-se no link Editar, sendo aberta uma página com os dados cadastrados, onde poderá ser realizada a alteração, para realizar a alteração clicar no botão SALVAR ALTERAÇÕES, para que os novos dados sejam gravados. 1.3.2.3 Excluir Legislação O sistema de cadastro de legislação utiliza como referência ao nome da legislação e o seu código, gerado no momento do seu cadastro, código este único para cada nome de legislação criado, desta forma não é possível realizar a exclusão de uma legislação cadastrada. O principal motivo é que se este for excluído os links apresentarão erro em suas referências, ficando o sistema instável. Assim, os nomes das Legislações só poderão ser ALTERADOS, ver item 1.3.2.2. 1.3.2.4 Inserir Imagem em uma Legislação Para a inserção de uma imagem no corpo de uma legislação seguir os seguintes passos: a) Criar uma pasta no desktop, ou local de fácil acesso para salvar as imagens contidas dentro das legislações que deverão ser inseridas no novo sistema; b) Abrir a legislação que contém as imagens que deverão estar no novo sistema de legislação; c) Clicar sobre a imagem selecionando-a; d) Clicar com o botão direito sobre a imagem selecionada e escolher a opção SALVAR FIGURAS ou SALVAR IMAGEM, dependendo do editor de texto que se está utilizando (BrOffice ou Word etc.); e) Na tela que se abrirá, dar um nome a esta imagem que represente de qual legislação pertence e em qual posição ou local da lei ela pertence, IMPORTANTE saber, este nome será utilizado posteriormente para a inserção desta imagem dentro do cadastro desta lei, por isso deve-se dar um nome curto, simples, mas que identifique a imagem e que NÃO esteja REPETIDO para não ocasionar conflito. Selecionar a pasta criada no item a, salvando o arquivo; Pág 15/22
f) Enviar as imagens para o servidor do sistema, para isto utilizar o programa SSH. Abrir o programa, colocar a senha. Após logar no programa uma tela semelhante do SSH será mostrado, como segue: No lado esquerdo do programa seleciona-se a pasta que contém as imagens no seu PC, abaixo será mostrado o conteúdo desta pasta. Ao lado direito será aberto diretamente a pasta sislegis, onde deverá ser enviado as imagens. Para o envio das imagens, seleciona-se as imagens e clica-se com o botão direito sobre as imagens selecionadas e seleciona-se o UPLOAD, espera-se carregar, as imagens serão enviadas para o lado direto, para o SERVIDOR. Ver imagem de Upload. Pág 16/22
g) Com a imagem já no servidor, agora já é possível inserir as imagens no corpo da legislação. Para isto, no editor da legislação clique no ícone Imagem, conforme imagem abaixo: Será aberta uma caixa de diálogo onde deverá ser preenchido o caminho da imagem. Este caminho deverá ser colocado em URL, da seguinte forma:../sislegis/nomeimagem.extensão (dois pontos, barra, sislegis, barra, nome da imagem, ponto, extensão da imagem). Ver imagem de exemplo: Após colocar o caminho da imagem, clicar em OK, a imagem será inserida no corpo da legislação, no lugar onde estiver o cursor de edição de texto. NÃO haverá a necessidade de alterar as medidas da imagem, ao gerar o arquivo para impressão o sistema ajustará automaticamente a imagem para caber dentro da área configurada para impressão. Pág 17/22
Após inserir todas as imagens pertencentes a legislação, clicar em Salvar Legislação, para que os caminhos das imagens sejam criados e as imagens adicionadas no corpo da legislação. 1.3.3 Cadastro de Legislação em Destaque A abertura da tela de cadastro de legislação em destaque poderá ser realizada pelo menu na tela principal do sistema. Ver imagem de acesso. Menu de acesso ao Cadastro de Legislação em Destaque Pág 18/22
Após o menu ser acionado será aberta a seguinte tela de cadastro: Tela de Cadastro 1.3.3.1 Inserção de nova legislação em destaque Para o cadastro de uma nova legislação em destaque faz-se a seleção do Link Top Legislação no submenu Legislação na aba CADASTROS, preenchendo o formulário com os seguintes dados: Tipo da Legislação (Lei, Lei Complementar ou Decreto), Número da Legislação (Obrigatório ser preenchido, porque é por ele que se irá buscar no cadastro a lei a ser exibida para o usuário final público) e descrição (não aparecerá ao público, é apenas para gerenciamento interno e identificação da legislação que se pôs em destaque). Após a inserção dos dados, deve-se Pág 19/22
selecionar o botão Salvar, sendo emitido a seguinte mensagem: Seus dados foram inseridos com sucesso!, para assim gravar a Lista com as Legislações que ficarão em destaque. 1.3.3.2 Editar legislação em destaque Para a edição de uma legislação em destaque faz-se a seleção do Link Top Legislação no submenu Legislação na aba CADASTROS, tendo acesso a listagem já em edição das legislações. Para alterar o tipo, número ou descrição basta alterar os dados já escritos, clicando-se em SALVAR para gravar as modificações. 1.3.3.3 Excluir legislação em destaque Para a exclusão de uma legislação em destaque faz-se a seleção do Link Top Legislação no submenu Legislação na aba CADASTROS. Para que esta não apareça na listagem em destaque, basta que seu número de legislação seja apagado da lista e seja SALVO a operação. 1.3.4 Cadastro de Anexo A abertura da tela de cadastro de anexo poderá ser realizada pelo menu na tela principal do sistema. Ver imagem de acesso. Menu de acesso ao Cadastro de Anexo Pág 20/22
Após o menu ser acionado será aberta a seguinte tela de cadastro: Cadastro de Anexo 1.3.4.1 Novo Anexo Para o cadastro de um novo Anexo faz-se a seleção do Link Inclusão no submenu Anexos aba CADASTROS, preenchendo o formulário com os seguintes dados: Tipo de Legislação, número da legislação, nome do anexo (seguir uma lógica de nomenclatura para que possa ser identificado o anexo no momento de referenciá-lo dentro da legislação) e formato da página (retrato ou paisagem). Após a inserção dos dados, deve-se selecionar o botão Salvar Anexo, sendo emitido a seguinte mensagem: Seus dados foram inseridos com sucesso!, para assim gravar a novo Anexo. 1.3.4.2 Editar Anexo Para a edição de um anexo deve-se consultar a lista de anexos no link Pesquisa/Alteração no submenu Anexos na aba Cadastros, onde será gerada uma lista com os anexos cadastrados no sistema. Para alteração de algum dado clica-se no link Editar, sendo aberta um página com os dados cadastrados, onde poderá ser realizada a alteração, após clicar no botão Salvar Alterações, para que os novos dados sejam gravados. 1.3.4.3 Excluir Anexo Não será possível excluir um anexo cadastrado, apenas alterar suas informações. Para realizar alterações ver item 1.3.4.2. Pág 21/22
1.3.5 Formatação extra para a Ementa ATENÇÃO apenas execute este procedimento se você realmente souber o que estiver fazendo, caso contrário o texto da legislação poderá sofrer modificações de formatação, ou conteúdo. Por isso execute apenas o procedimento abaixo descrito. Para a formatação correta da ementa, deve-se seguir os passos a seguir, a formatação da ementa será dada diretamente no código html no momento da criação da legislação, sendo executada apenas uma vez, a cada criação de legislação, esta formatação tira o espaço de parágrafo adicionado no momento que se faz a colagem do texto no editor, para se deixar a ementa com texto justificado sem espaçamento faz-se o seguinte: a) Abaixo do texto CORPO DA LEGISLAÇÃO, há uma ícone escrito Código-Fonte, como abaixo clicando-se neste item o código html de criação da página será exibido. b) Procura-se no código exibido o início do texto da ementa: procure a linha anterior que contenha o seguinte texto: <p align="justify" class="western" style="margin-left: 6.67cm; margin-bottom: 0cm">, aqui verifica-se que o margin-left: 6.67cm pode conter outro valor, e o margin-bottom: 0cm, pode não aparecer em algumas configurações, isto tudo vai depender das configurações da legislação original. Encontrando esta linha, acrescentar antes da última aspas dupla um ponto e vírgula e o seguinte comando text-indent:0cm, ficando como no exemplo abaixo (seguir a sequência de pontos e vírgulas e aspas duplas): <p align="justify" class="western" style="margin-left: 8cm; margin-bottom: 0cm; textindent:0cm">. Pág 22/22
Sugestões, Dúvidas e questionamentos podem ser realizados diretamente com a equipe desenvolvedora, localizada da sede da Prefeitura Municipal de Cachoeirinha-RS, no setor de Tecnologia da Informação TI. E-mail de contato: fabrica@cachoeirinha.rs.gov.br telefone: 30417124/30417145. Pág 23/22