Memória Persistente - MP-Biz - Manual do Utilizador

O MP-Biz – Sistema de Apoio à Gestão, do qual esta aplicação é apenas o primeiro elemento, irá ser um pacote de ferramentas para o auxiliarem na gestão do seu Negócio.

Tendo como elemento essencial uma estrutura de dados cuidadosamente desenhada e que reflete uma vasta experiência na concepção de aplicações de gestão, é constituída por:

Apostando tanto na verstibilidade como na fiabilidade do que é mais precioso para a sua Empresa – a Informação, todas as aplicações do pacote que agora se inicia serão, tanto quanto possível, agnósticas em relação à Base de Dados com que irão trabalhar, permitindo, assim, escolher a que melhor se adapta às necessidades da sua Empresa.

Optando por separar os dados da aplicação, garantimos tanto a fiabilidade adequada, como a máxima escalabilidade.

Tendo o Sistema como base a linguagem Java, fica garantido o seu bom funcionamento na maior parte dos Sistemas Operativos, desde o 'velhinho' Windows 95 até ao XP, MacOS/X, Solaris, Linux, entre outros.

0.2. O que é o Evaristo?

Pensado para simplificar as tarefas do dia-a-dia de uma pequena ou média Empresa, a sua interface com o utilizador foi simplificada ao máximo, de maneira a reflectir aquilo que é comum a todos os negócios: os Produtos com que trabalhamos, as Entidades com que negociamos e os Documentos que justificam os respectivos saldos.

O Evaristo, primeiro elemento do MP-Biz a 'ver a luz do dia', não é mais do que uma Aplicação Java que trabalha em conjunto com uma Base de Dados, contendo tanto a interface como as 'regras do negócio', com é ilustrado no diagrama abaixo.

Fig. 0.2 - Arquitectura da Aplicação

Feito a pensar no futuro, a totalidade dos seus ecrãs (incluindo listagens) têm a sua aparência (desde o tamanho e tipo de letra até ao conjunto de campos a mostrar) definida em ficheiros XML, o que torna qualquer alteração extremamente simples e portável.

1. Instalação

Para instalar basta descompactar o ficheiro mpb2-1-final-all.tgz para um directório da sua escolha (p. ex.: /usr/local/m16e) – ver Instalação rápida para fazer um mínimo de alterações à configuração. Uma vez descompactado serão criados os seguintes ficheiros e directórios:

Fig. 1.1 - Árvore de directórios da aplicação

Directório	Descrição
evaristo-v2r1	directório base de Evaristo
evaristo-v2r1/diagrams	estrutura de dados da aplicação (p/ abrir c/ o Gaudí)
evaristo-v2r1/doc	documentação da aplicação
evaristo-v2r1/img	ícones da aplicação
evaristo-v2r1/sql	contém um ficheiro com o dump de uma Base de Dados já inicializada (exemplo p/ PostgreSQL)
evaristo-v2r1/xgui	ficheiros com as descrições das janelas da aplicação
evaristo-v2r1/lib	contém os pacotes (jar) necessários ao funcionamento da aplicação

Tabela 1.1 - Directórios da aplicação

Ficheiro	Descrição
company-data.xml	Dados da Empresa
db-field-types.xml	tipos de campos da Base de Dados
evaristo.sh	shell script p/ lançar a versão Back Office da aplicação
evaristo-pos.sh	shell script p/ lançar a versão P.O.S. da aplicação
evaristo-tools.sh	ferramentas de manutenção e administração
init-data.xml	ficheiro com dados de arranque
mpbiz-backoffice.properties	ficheiro de configuração da aplicação
mpbiz-pos.properties	ficheiro de configuração da versão P.O.S.

Tabela 1.2 - Principais ficheiros da aplicação

De seguida, dever-se-á criar as tabelas na Base de Dados, da qual se encontra um exemplo (para PostgreSQL) no no directório 'dump'.

1.1. Instalação rápida (p/ PostgreSQL)

Findo isto, deverá reinicializar o servidor de dados (code>/etc/init.d/postgresql restart) e proceder à extracção dos ficheiros da aplicação:

1.2. Conversão da Versão 1.0

1.3. Conversão da Versão 1.1.x

1.4. Conversão da Versão 1.2

Com o GAUDÍ abrir o diagrama evaristo-v1r2.xml e executar as seguintes tarefas:
– Data I/O -> Export.

sair do GAUDÍ e executar os seguintes comandos:
– dropdb mpbiz
– createdb -E LATIN9 mpbiz

Com o GAUDÍ abrir o diagrama evaristo-v2r0.xml e executar as seguintes tarefas:
– Wizards -> Rebuild the Database
– Wizards -> Import
– Wizards -> Rebuild Foreign Keys

sair do GAUDÍ e executar os seguintes comandos na shell:
– psql -f mpbiz-fn.sql mpb2 (p/ criar as funções).
– ./evaristo-tools.sh -a (ler definições novas de documentos)
– ./evaristo-tools.sh -r (reconstrução dos documentos)

1.5. Conversão da Versão 2.0

Uma vez que não há alterações na estrutura de dados, não é necessário proceder a qualquer conversão.

2. Configuração

2.1. Descrição dos ficheiros de configuração

2.1.1. company-data.xml

Este é o ficheiro onde serão guardados os dados da sua Empresa e que irão constituir o conteúdo do cabeçalho dos documentos a emitir.

Etiqueta (Tag)	Descrição
company-data	Dados da Empresa. Raíz da árvore XML.
company-long-name	Nome completo da Empresa
company-short-name	Nome abreviado da Empresa.
company-address	Morada da Empresa. É constituído por um ou mais elementos (item).
finantial-id	Número de Identificação Fiscal da Empresa.
telephones	Telefones da Empresa. É constituído por um ou mais elementos (telephone).
url	URL do site da Empresa
e-mail	e-mail genérico da Empresa.

Tabela 2.1 - Campos do ficheiro company-data.xml.

2.1.2. db-field-types.xml

Contém definições de tipo para diferentes Bases de Dados e, em princípio, não precisará de ser mudado.

2.1.3. mpbiz.properties

Este ficheiro contém os parâmetros de funcionamento da aplicação e dele se fornece um exemplo para uma Base de Dados PostgreSQL, chamada 'teste', instalada numa máquina chamada 'kerouac', e com o utilizador 'carlos':

Propriedade	Descrição
db.driver.name	Nome do driver.
db.driver.protocol	Nome do protocolo.
db.sep.pm	Separador protocolo / nome da máquina.
db.machine	Nome da máquina.
db.sep.md	Separador nome da máquina / nome da Base de Dados.
db.schema	Esquema a que pertence a Base de Dados.
db.password	Password do utilizador.
db.user	Nome do utilizador.
db.family	Família da Base de Dados (v.' `db-field-types.xml'`).
xgui.dir	Directório onde são guardadas as descrições dos ecrãs.
locale.language	código da linguagem (ISO 639 - 2 caracteres - minúsculas)
locale.country	código do país (ISO 3166 - 2 caracteres - maiúsculas)
locale.variant	variante local (no nosso caso: `EURO`)
timezone	hora do local (no nosso caso: `Europe/Lisbon`)
browser	browser a usar para mostrar a documentação
uid	nome do utilizador (p/ ambientes seuros)
pid	password do utilizador (p/ ambientes seuros)
barcode	tipo de código de barras a usar (EAN13 ou EAN8)
pos.printer	código da impressora de talões
pos.display	código do display de cliente
tax.inc	define a inclusão ou não do IVA nos preços dos produtos
prod_id.field	tipo de identificador preferencial de produtos prod_id código do produto barcode código de barras alfa_code código alfanumérico

Tabela 2.2 - Campos do ficheiro mpbiz.properties.

2.1.4. xgui/inc-company-data.xml

Este é o ficheiro onde estão guardados os dados da sua Empresa relativamente ao conteúdo do cabeçalho dos documentos a emitir.

3. A Aplicação

3.1. Lançando a Aplicação

Uma vez lançada a aplicação, caso a Base de Dados esteja vazia, será previamente preenchida com os dados contidos no ficheiro 'init-data.xml' que, entre outras coisas, preenche as tabelas de utilizadores e parametrização do Sistema com opções genéricas.

De seguida, aparece uma janela onde nos é solicitado o nosso nome e password. Quando da primeira instalação é criado um super-utilizador com o nome e a password igual a 'admin'.

Finalmente, aparece a seguinte janela (colocando o cursor sobre os ícones aparecerá uma pequena descrição):

Fig. 3.1 – Ecrã Principal

	Entidades: - Nova Entidade - Lista de Entidades
	Produtos: - Editar Produtos - Lista de Produtos
	Documentos: - Novo Documento - Lista de Documentos - Lista de Documentos por Emitir - Lista de Documentos por Pagar
	Tabelas de Parametrização: - Regras de Evolução dos Documentos - Utilizadores - Tipos de Entidade, Produto e Documento - Armazéns, Unidades de Movimentação e Taxas
	Inventário - Começar Inventário - Actualizar Produtos p/ Inventário - Continuar Inventário - Imprimir Inventário - Integerar Inventário
	Ajuda - Àcerca do Evaristo - Manual do Utilizador - Ligação à Base de Dados
	Listagens - Compras - por Fornecedor - por Produto - Vendas - por Cliente - por Produto - Documentos por Pagar - Emissão de avisos de crédito - Mapa do I.V.A. - Resumo de Documentos - Detalhe de Documentos - Produtos - Existências - Movimentos de Produtos

Tabela 3.1 - Opções do Ecrã Principal

É a partir desta janela que se trabalha com a aplicação, concentrando aqui a origem de todas as acções a desencadear.

3.2. Interface com o Utilizador

O comportamento e as funcionalidades da interface com o utilizador, são – tanto quanto possível – uniformes ao longo da aplicação. Ficam em baixo alguns exemplos que são transversais à aplicação:

Ajuda ao preenchimento de campos

Alguns campos possibilitam invocar ecrãs de listas de registos de ajuda ao preenchimento dos respectivos valores. São disso exemplo o Código de Entidade e o Código de Produto, no ecrã criação de uma Encomenda ou Factura.

No caso de tabelas, essa possibilidade é sinalizada com um asterisco junto ao título do respectivo campo, sendo nos outros casos através de um fundo azulado.

Fig. 3.2.1. – Ajuda ao preenchimento

Ordenar as Listas

Para ordenar a lista por uma determinada coluna, basta carregar com o botão esquerdo do rato no título da coluna pela qual pretendemos ordenar. Caso se pretenda ordenar por mais do que uma coluna, deveremos repetir a operação para cada umas das colunas, mas pela ordem inversa da pretendida.

Limitar o número de registos das Listas

Nos ecrãs de listas que contenham o ícone de pesquisa

poderemos limitar o número de registo por qualquer dos campos constantes do ecrã.

Carregando neste ícone, aparece um ecrã onde poderemos introduzir novos limites para a lista, que serão aplicados cumulativamente.

Caso pretendessemos limitar a Lista de Produtos da Fig. 5.3 a produtos cujo nome começasse por 'impressora' – ignorando a direfença entre maiúsculas e minúsculas – ou áqueles cuja quantidade é igual a zero, poderíamos aplicar os seguintes limites:

Fig. 3.2.2 – Limitar uma Lista

Fig. 3.2.3 – Aós aplicação dos limites.

Por outro lado, a partir da versão 2.0 existem ecrãs dedicados para as pesquisas de Entidades e Produtos.

Nestes ecrãs, deverá seleccionar a check-box correspondente ao item (ou conjunto de itens) que pretende usar para a pesquisa.

Fig. 3.2.4 – Ecrã de limites para Entidades.

Fig. 3.2.5 – Ecrã de limites para Produtos.

Atalhos de Teclado

Os atalhos de teclado seguem o comportamento habitual deste tipo de aplicações (em geral) e de aplicações Java (em particular), num entanto, segue-se um pequeno resumo para quem quiser trabalhar mais rápido (ou sem rato).

4. Entidades

Por Entidades entende-se os seus parceiros no Negócio: Clientes, Fornecedores e outros.

As Entidades são identificadas por um código unívoco, podendo cada Entidade pertencer a um ou mais tipos. Adicionalmente poderão ser igualmente validadas através do seu Número de Identificação Fiscal. A intenção é permitir que a mesma Entidade possa ser simultaneamente Cliente e Fornecedor, ou Fornecedor e Sócio, por exemplo.

4.1 – Ecrã de edição de Entidades

Fig. 4.1 – Ecrã de edição de Entidades

	Registo Anterior
	Criar Registo
	Procurar Registo – procura um registo com base no código da Entidade
	Alterar Registo – actualiza na Base de Dados a informação entretanto alterada no ecrã (o código da Entidade não pode ser alterado, uma vez que constitui o identificador da Entidade)
	Apagar Registo – apaga um registo com base no código da Entidade
	Próximo Registo
	Cotações de Produtos - por Fornecedor
Cliente	Entidade Finenceira - atributos como Cliente
Fornecedor	Entidade Finenceira - atributos como Fornecedor

Tabela 4.1 - Opções do Editor de Entidades

4.2 – Cotação de Produtos

O ecrã de Entidades dispõe de um atalho para inserção de cotações de Produtos dessa Entidade

Teclas de atalho:

[Insert]	insere linhas – mostra a lista de Produtos donde poderá escolher aquele(s) que pretende acrescentar (seleccionando-os e carregando no botão de fechar a janela
[Delete]	apaga as linhas seleccionadas

Fig. 4.2 – Ecrã de Cotação de Produtos (p/ Produto)

Tabela 4.2 - Opções do Editor de Cotações de Produtos

4.3 – Listagens de Entidades

Fig. 4.3 – Listagem de Entidades

	Fecha a Janela
	Refrescar – actualiza a lista
	Editar – edita registo
	Inserir – cria um novo registo
	Procurar – limita o conjunto listado
	Imprime
	Conta Corrente – imprime a Conta Corrente da Entidade
	Documentos por Pagar – imprime os documentos por pagar da Entidade

Tabela 4.3 - Opções da Listagem de Entidades

Por Produto entende-se o objecto do negócio, seja ele um serviço, ou um produto manufacturado. Trata-se de uma estrutura que virtualiza o objecto do negócio.

5.1. Ecrã de Edição de Produtos

Os Produtos são identificados univocamente pelo seu código (número), podendo igualmente ser identificados no sistema pelo seu código de barras ou pelo código alfanumérico, conforme a parametrização do ecrã.

Fig. 5.1 – Ecrã de edição de Produtos

Ícone	Atalho	Descrição
	[UP]	Registo Anterior
	[CTRL]+N	Criar Registo
	[CTRL]+F	Procurar Registo – procura um registo com base no código do Produto
	[CTRL]+S	Alterar Registo– actualiza na Base de Dados a informação entretanto alterada no ecrã (o código do Produto não pode ser alterado, uma vez que constitui o identificador do Produto)
	[CTRL]+D	Apagar Registo – apaga um registo com base no código do Produto
	[DOWN]	Próximo Registo
		Cotações de Produtos - por Produto
	[CTRL]+R	Recalcular Código de Barras - validar código de barras e recalcular check digit.
	–	Adicionar registo - adiciona um novo registo à lista

Tabela 5.1 - Opções do Editor de Produtos

5.2. Cotação de Produtos

Carregando no botão esquerdo do rato no ícone de cotações

, aparece uma janela com a lista das diversas cotações do produto junto dos vários Fornecedores. Para inserir um registo, carrague na tecla [Insert]. de seguida, surge a lista das Entidades, donde deverá escolher aquela(s) cujas cotações pretendamos inserir. Para remover um registo basta seleccinar a respectiva linha e carregar na tecla [Delete].

Fig. 5.2 – Ecrã de Cotação de Produtos (p/ Produto)

Tabela 5.2 - Opções do Editor de Cotações de Produtos

5.3. Listagem de Produtos

Fig. 5.3 – Listagem de Produtos

	Fecha a Janela
	Refrescar – actualiza a lista
	Editar – edita registo
	Inserir – cria um novo registo
	Procurar – limita o conjunto listado
	Imprime
	Conta Corrente – imprime a Conta Corrente do Produto

Tabela 5.3 - Opções da Listagem de Produtos

6. Documentos

Os Documentos constituem o meio de justificar as alterações aos dados, e têm 3 atributos chave: tipo de entidade, tipo do documento e código do documento.

Os vários tipos de documento são definidos através da inclusão das respectivas regras de evolução (v. Tabelas de Parametrização), sendo que, na maior parte dos casos, não implicarão alterações ao código da aplicação.

6.1. Criar Novo Documento

Do menú constam 4 opções principais: 'Novo Documento', 'Listar Documentos', 'Listar Documentos por Emitir' e 'Listar Documentos por Pagar'. Escolhendo a primeira opção aparecerá um sub-menu com os vários tipos de entidade e, por cada tipo de entidade, os vários tipos de documento possíveis.

Fig. 6.1 – Opções de Documentos

Neste momento, existem dois grupos de documentos que requerem tipos de ecrã distintos: os de moviminveentos de produtos (encomendas, facturas, guias de remessa, etc.) e os de movimentos financeiros (recibos e adiantamentos).

Em baixo, mostra-se um exemplo de um ecrã de criação de documentos relativos a Produtos, neste caso, a vulgar Venda a Dinheiro.

Fig. 6.2 – Novo Documento

De notar que os campos referentes ao Código do Documento e Data do Documento já vêm preenchidos, sendo o código do documento calculado segundo o seguinte algoritmo:
– se já houver documentos para este tipo de Entidade e de Documento, obtém o valor do código do último documento.
– se ainda não houver documentos deste tipo o seu valor é obtido da tabela 'tab_doc_props', do campo 'start_number'.
Em qualquer dos casos o valor assim obtido é incrementado de uma unidade.

O campo referente à data do documento é normalmente editável o que, permitindo criar documentos com datas diferentes da data corrente, deverá ser usado com cuidado ou simplesmente inibido.

6.1.1. Procurar Entidade

Premindo o botão direito do rato sobre o campo do Código de Entidade (o campo tem fundo azul-claro, o que indica que dispõe de ajuda ao preenchimento), aparece um menu, que neste momento aprresenta apenas uma opção – 'Entidades por Nome', que, ao ser seleccionada, faz aparecer a Lista de Entidades donde será escolhida a Entidade pretendida.

6.1.2. Procurar Produtos

Premindo o botão direito do rato sobre o campo do Código de Produto no painel das linhas do documento (o asterisco na barra do título indica que o campo dispõe de ajuda ao preenchiemto), aparece um menu, com as seguintes opções:

6.1.3. Antever Impressão

Premindo o botão 'Antever Impressão', o Documento é validado, mostrando uma antevisão de como será o seu aspecto uma vez impresso. Uma vez fechada esta janela, volta-se ao documento que se estava a produzir.

Esta opção é particularmente útil nos documentos cujas linhas contêm descrições de serviços, assegurando que o conteúdo do campo 'Designação' seja completamente visível no documento impresso.

6.1.4. Criar Documento

Premindo o botão 'Cria Documento', o Documento é validado e processado, dando origem a uma antevisão de como será o seu aspecto uma vez impresso.

6.1.5. Guardar Documento

Premindo o botão 'Guarda Documento', o Documento é guardado na Base de Dados para processamento posterior, podendo depois ser acedido através da opção 'Listar Documentos por Emitir' do menú de 'Documentos' (v. Fig. 6.1 ).

6.2. Listagens de Documentos

7. Tabelas de Parametrização

Por Tabelas de Parametrização entende-se o conjunto de tabelas que contêm os dados sobre a configuração da aplicação e estão assecíveis premindo o botão esquerdo do rato sobre o ícone respectivo.

Fig. 7.1 – Opções de Tabelas

7.1. Tabelas de Utilizadores

7.1.1. Utilizadores

Nesta tabela são definidos os utilizadores do sistema. Cada registo contém um identificador do utilizador, o login, a password e o nome do utilizador.

7.1.2. Perfis dos Utilizadores (grupos)

Nesta tabela é feita a associação entre o utilizador e os grupos (perfis) a que pertence.

7.1.3. Privilégios dos Utilizadores

Neste momento está ainda parcialmente por implementar, sendo somente feita a distinção entre o Administrador do Sistema e os outros utilizadores. Basicamente consiste em omitir a opção Tabelas do menú principal.

7.2. Entidades

7.2.1. Tipos de Entidade

Fig. 7.2.1 – Tabela de Tipos de Entidade

7.2.2. Entidades Financeiras

Fig. 7.2.2 – Tabela de Entidades Financeiras

Todas as entidades financeiras (Clientes, Fornecedores e outras com impacto financeiro) têem um entrada nesta tabela. Aqui são guardados os totais a crédito e a débito, o volume de negócios, prazos de pagamento e plafonds.

7.3. Tabelas de Documentos

7.3.1. Tipos de Documentos

Fig. 7.3.1 – Tabela de Tipos de Documentos

Nesta tabela são descritos os vários tipos de documento suportados pela aplicação, bem como o tipo de ecrã a utilizar. O campo 'Tipo de Linha' permite distinguir entre os documentos que dizem respeito a produtos ou serviços e os documentos financeiros.

7.3.2. Propriedades dos Documentos

Fig. 7.3.2 – Tabela de Propriedades dos Documentos

Nesta tabela é guardada informação especializada sobre cada tipo de documento.

Campo	Descrição
Tipo Ent.	tipo de Entidade
Tipo Doc.
Nome do Documento	nome com que o Documento é identificado externamente
Nº Cópias	número de cópias do Documento a imprimir
Nº Doc. Inicial	número a partir do qual começa a contagem dos Documentos
Modelo	nome do ficheiro XML que contém o modelo de interface a utilizar

Tabela 7.3.4 - Regras de Evolução de Documentos

7.3.3. Regras de Evolução dos Documentos

Esta é a tabela mais complexa de todas e contém as regras de criação e evolução de documentos. Aqui são definidas quais as operações a realizar quando da criação de um documento, isto é, quais os campos de que tabelas são afectados e de que maneira o são.

Fig. 7.3.4 – Regras de Evolução de Documentos

Campo	Descrição
Tipo Ent.	tipo de Entidade
Tipo Doc.	tipo de Documento
Tipo Doc. (orig.)	tipo de Documento de origem
Nº Regra	identificador da regra
Tabela	tabela a actualizar
Campo Alvo	nome do campo a actualizar
Factor	factor a aplicar à operaçao
Update	valor de actualizaçao
Where	cláusula where (SQL) com os limites da operação
Condição	condição a testar a execussão da regra (SQL procedure)
Nome	nome da regra (opcional)
Descrição	descrição da regra (opcional)

7.4. Tabelas de Produtos

7.4.1. Tipos de Produto

Fig. 7.4.1 – Tabela de Tipos de Produto

7.4.2. Armazéns

7.4.3. Famílias de Produtos

7.4.4. Unidades de Movimentação

7.5. Tabela de Moedas

Fig. 7.5 – Tabela de Moedas

7.6. Tabela de Taxas

7.7. Tabela de Validação de Taxas

Fig. 7.7 – Tabela de Validação de Taxas

8. Inventário

Esta opção, tal como a anterior só disponível para o administrador do sistema, permite realizar acertos de inventário, ou seja, a partir de uma única janela poderá alterar as quantidades existentes no(s) seu(s) armazém(ns) sendo no final criado um documento justificativo.

8.1. Começar Inventário

Esta opção reinicializa a tabela de inventário e mostra a janela de contagem de stocks. Todas as alterações são realizadas numa tabela própria de modo a não impedir o normal funcionamento do seu negócio.

8.2. Continuar Inventário

Mostra a janela descrita no ponto anterior (8.1) de modo a poder prosseguir a contagem de existências.

8.3. Imprimir Inventário

Mostra umaa janela preparada para imprimir a sua contagem.

8.4. Integrar Inventário

Integra a contagem realizada na base de dados, criando um documento – Acerto de Inventário – justificativo das alterações realizadas às existências.

MP-Biz – Sistema de Apoio à Gestão (v2r1)

Manual do Utilizador

0. Introdução

0.1. O que é (e vai ser) o MP-Biz?