manual de integração - primavera bss...gestão documental – manual de integração primavera –...
TRANSCRIPT
Manual de
Integração
Interface Gestão Documental
Plataforma PRIMAVERA
Dezembro 2010
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
2
Índice
Índice ............................................................................................................................ 2
Introdução .................................................................................................................... 5
Sistema Gestão Documental integrando Plataforma PRIMAVERA ................................... 6
Modelo Conceptual ...................................................................................................... 6
Modelo Funcional ........................................................................................................ 7
Funcionalidades .......................................................................................................... 7
Activação do Serviço nos Módulos PRIMAVERA ................................................................ 8
Componente de Integração .......................................................................................... 8
Propriedades do Componente ..................................................................................... 8
Classes Necessárias .................................................................................................. 8
Métodos e Propriedades Obrigatórios ........................................................................... 9
clsAbout.ApplicationName ....................................................................................... 9
clsAbout.ApplicationVersion ..................................................................................... 9
clsAbout.APIVersion ............................................................................................... 9
clsAbout.Copyright............................................................................................... 10
clsFilter.DocumentType ........................................................................................ 10
clsFilter.EntityType .............................................................................................. 10
clsFilter.EntityName ............................................................................................. 10
clsFilter.ModuleId ................................................................................................ 10
clsOperational.AssociateDocuments ........................................................................ 10
clsOperational.RemoveAssociation.......................................................................... 11
clsOperational.ViewDocuments .............................................................................. 11
Métodos e Propriedades Opcionais ............................................................................ 11
clsOperational.CompanyId .................................................................................... 11
Compatibilidade ..................................................................................................... 11
Operações de Integração ........................................................................................... 12
“Acerca De” ........................................................................................................... 12
“Operacional” ........................................................................................................ 12
Configuração ......................................................................................................... 13
Módulos PRIMAVERA ................................................................................................. 14
Logística e Tesouraria ......................................................................................... 14
Módulo VND – Vendas .......................................................................................... 14
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
3
Módulo CMP - Compras......................................................................................... 14
Módulo STK – Stocks............................................................................................ 14
Módulo CCT – Contas Correntes ............................................................................. 15
Módulo TES – Tesouraria ...................................................................................... 15
Módulo CLI – Clientes ........................................................................................... 15
Módulo FOR – Fornecedores .................................................................................. 15
Módulo TER – Outros Terceiros .............................................................................. 16
Módulo SOC – Sócios/Accionistas ........................................................................... 16
Módulo EST – Estado/Outros Entes Públicos ............................................................. 16
Módulo ART – Artigos ........................................................................................... 16
Módulo INT – Documentos Internos ........................................................................ 16
Contabilidade ...................................................................................................... 16
Módulo MOV – Movimentos Contabilísticos ............................................................... 16
Módulo CLI – Clientes ........................................................................................... 17
Módulo FOR – Fornecedores .................................................................................. 17
Módulo TER – Outros Terceiros .............................................................................. 17
Equipamentos e Activos....................................................................................... 17
Módulo FIC – Fichas de Equipamentos/Activos ......................................................... 17
Recursos Humanos .............................................................................................. 17
Módulo FUN – Funcionários ................................................................................... 17
Módulo IND – Independentes ................................................................................ 17
Módulo ALT – Alterações Mensais ........................................................................... 18
Módulo DES – Despesas ....................................................................................... 18
Módulo FER – Férias ............................................................................................. 18
Tipos de Entidades .................................................................................................... 18
Localização no ERP das integrações com a GDOC ........................................................... 19
Sistema Gestão Documental integrando Aplicações Externas ....................................... 20
Plataforma – Interface de Gestão Documental .......................................................... 20
Plataforma.GestaoDocumental.InterfaceActivo ......................................................... 20
Plataforma.GestaoDocumental.InicializaModulo ........................................................ 20
Plataforma.GestaoDocumental.AssociaDocumentosEx ............................................... 21
Plataforma.GestaoDocumental.ConsultaDocumentos ................................................. 21
Plataforma.GestaoDocumental.RemoveAssociacao .................................................... 21
Plataforma.GestaoDocumental.TerminaModulo ......................................................... 22
Exemplo – Módulo de Compras (L&T) ........................................................................ 22
Inicialização do Módulo .............................................................................................. 22
Identificador do Módulo ........................................................................................... 22
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
4
Invocação de InicializaModulo .................................................................................. 23
Construção das Opções na Toolbar (Contexto)............................................................... 23
Finalização do Módulo ................................................................................................ 24
Associação de Imagens .............................................................................................. 24
ActiveBar_ToolClick ................................................................................................ 24
GDOC_Associar ...................................................................................................... 24
Visualização de Imagens ............................................................................................ 25
ActiveBar_ToolClick ................................................................................................ 26
GDOC_Visualizar .................................................................................................... 26
Remoção da Associação ............................................................................................. 27
ActiveBar_ToolClick ................................................................................................ 27
GDOC_Remover ..................................................................................................... 27
Base de Dados ......................................................................................................... 28
Exemplo ...................................................................................................................... 29
Digitalização da Imagem .......................................................................................... 29
Classificação ............................................................................................................. 29
Workflow .................................................................................................................. 30
Criação da Factura .................................................................................................... 30
Associação ................................................................................................................ 30
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
5
Introdução
Este documento apresenta duas possibilidades de integração de um sistema de
Gestão Documental:
1. Integração com a Plataforma PRIMAVERA;
2. Integração com uma aplicação externa que, por sua vez, se
encontra integrada com o ERP PRIMAVERA.
Em primeira análise, este documento descreve a Tecnologia de Gestão
Documental tal como implementada no ERP PRIMAVERA na versão 7.50
(Professional e Executive).
Esta tecnologia permite a disponibilização de funcionalidades de Gestão
Documental nos vários módulos (Logística e Tesouraria, Contabilidade,
Recursos Humanos, Imobilizado e Gestão de Gabinetes).
Disponibiliza ainda funcionalidades integradas de Gestão Documental,
nomeadamente:
Associação de documentos geridos pela solução de Gestão
Documental a documentos e/ou entidades do sistema PRIMAVERA;
Consulta on-line das imagens associadas a cada documento/entidade
PRIMAVERA;
Pesquisa de documentos no sistema de Gestão Documental.
Este documento descreve o interface de integração entre a Plataforma
PRIMAVERA e uma solução de Gestão Documental.
Numa segunda análise, este documento apresenta as propriedades e funções
disponíveis na integração de um módulo específico (que por sua vez se
encontra integrado com o ERP PRIMAVERA) com um sistema de Gestão
Documental. Um exemplo desta integração será apresentado para servir de
apoio à análise.
Para finalizar, será apresentado um exemplo de um sistema de Gestão
Documental integrado com o ERP PRIMAVERA.
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
6
Sistema Gestão Documental integrando Plataforma PRIMAVERA
Modelo Conceptual O modelo conceptual da integração será o seguinte:
O diagrama anterior apresenta o modelo de comunicação entre o ERP
PRIMAVERA e o Sistema de Gestão Documental. Devem ser realçados os
seguintes aspectos deste modelo de integração:
Toda a solução de GDOC é da responsabilidade do Parceiro PRIMAVERA;
As ferramentas de Gestão Documental serão recomendadas pela
PRIMAVERA no âmbito do programa de Certificação de Soluções de
Parceiros;
As ferramentas de Gestão Documental – digitalização de imagens,
indexação, controlo de qualidade, arquivo digital, etc. – são
disponibilizadas pela solução GDOC e estão fora do âmbito da Tecnologia
de Integração Documental PRIMAVERA (TID);
O interface de integração – representado no diagrama pelo bloco central
“API de Integração” – é da responsabilidade do parceiro e trata de toda a
comunicação entre a Plataforma PRIMAVERA e a aplicação de GDOC.
Deve ser implementado através de um componente COM, obedecendo a
um interface pré-definido (descrito no capítulo “Modelo Funcional”) que
activará as funções de Gestão Documental nos módulos PRIMAVERA
instaladas;
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
7
Toda a comunicação entre os módulos PRIMAVERA e a aplicação de
Gestão Documental será efectuada a partir da Plataforma PRIMAVERA
através das classes, métodos e propriedades definidas no componente
que implementa a API de integração.
Na perspectiva do utilizador final – cliente da solução – esta integração é
disponibilizada como dois módulos distintos ainda que integrados:
A PRIMAVERA fornece o acesso às funcionalidades de Gestão Documental
a partir dos módulos (como se descreve de seguida);
O Parceiro fornece a solução de Gestão Documental (aplicação
propriamente dita) e o interface (componente ThrdDocSys e outros
associados) que implementam a integração com os módulos PRIMAVERA.
Modelo Funcional Este capítulo descreve o nível de integração definido nos produtos PRIMAVERA,
nomeadamente, as respectivas operações e activações de serviços de Gestão
Documental e a lista de módulos onde estão disponíveis.
Funcionalidades
A API de integração implementa as seguintes funcionalidades:
“Acerca de”: propriedades que permitam ao sistema PRIMAVERA obter
dados sobre a versão da aplicação de Gestão Documental (exemplos:
nome da aplicação, versão da aplicação, versão da API);
“Consulta/Associação”: consulta (filtrada) de documentos disponíveis
no sistema GDOC com possibilidade de efectuar, ou não, a associação
ao documento/entidade PRIMAVERA;
“Digitalização/Associação”: digitalização “on demand” de documentos
com possibilidade de efectuar, ou não, a associação ao
documento/entidade PRIMAVERA;
“Visualização”: visualização “on demand dos documentos (imagens)
associados ao documento/entidade PRIMAVERA.
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
8
Activação do Serviço nos Módulos PRIMAVERA
As funcionalidades de GDOC serão automaticamente activadas nos módulos
PRIMAVERA sempre que se verifiquem as seguintes condições:
O componente de implementação da API de integração
(ThrdDocSys.dll) existe na máquina e está devidamente configurada e
registada (responsabilidade do Parceiro);
A versão da DLL ThrdDocSys encontrada é compatível com a versão
da Plataforma PRIMAVERA e implementa todas as classes e métodos
definidos no contrato de integração.
Componente de Integração
A API de integração deve ser implementada por um componente COM.
Este componente deve implementar um conjunto de classes, métodos e
propriedades que, por sua vez, implementem cada uma das funcionalidades de
integração descritas anteriormente.
Propriedades do Componente
O componente deve ter as seguintes propriedades:
Project Type: ActiveX DLL
Project Name: ThrdDocSys
Physical Name: ThrdDocSys.dll
Classes Necessárias
Devem existir as seguintes classes:
clsAbout: objecto de informação sobre a aplicação e API de GDOC;
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
9
clsFilter: objecto de definição de filtros de pesquisa de
documentos/imagens;
clsOperational: objecto que disponibiliza as funcionalidades
operacionais.
Todas as classes devem ter as seguintes propriedades:
DataBindingBehavior: 0 (vbNone)
DataSourceBehavior: 0 (vbNone)
Instancing: 5 (MultiUse)
MTSTransactionMode: 0 (NotAnMTSObject)
Persistable: 0 (NotPersistable)
Métodos e Propriedades Obrigatórios
Os métodos e propriedades necessários para que a integração possa ser
efectuada devem ser implementados em cada uma das classes anteriores.
clsAbout.ApplicationName
Descrição Devolve o nome da aplicação
Tipo Propriedade
Parâmetros Nenhum
Resultado String Nome descritivo da aplicação
clsAbout.ApplicationVersion
Descrição Devolve a versão da aplicação
Tipo Propriedade
Parâmetros Nenhum
Resultado String Versão da aplicação
clsAbout.APIVersion
Descrição Devolve a versão da API
Tipo Propriedade
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
10
Parâmetros Nenhum
Resultado String Versão da API
clsAbout.Copyright
Descrição Devolve uma descrição do copyright da aplicação e da API
Tipo Propriedade
Parâmetros Nenhum
Resultado String Copyright
clsFilter.DocumentType
Descrição Tipo de documento PRIMAVERA (FAF, FAC, ENF, etc.)
Tipo Propriedade
Parâmetros Nenhum
Resultado String Tipo de documento
clsFilter.EntityType
Descrição Tipo de entidade PRIMAVERA (Cliente, Fornecedor, Devedor, etc.)
Tipo Propriedade
Parâmetros Nenhum
Resultado String Nome da entidade
clsFilter.EntityName
Descrição Nome da entidade PRIMAVERA (SOFRIO, ALCAD, etc.)
Tipo Propriedade
Parâmetros Nenhum
Resultado String Nome da entidade
clsFilter.ModuleId
Descrição Identificador do módulo PRIMAVERA (compras, vendas, etc.)
Tipo Propriedade
Parâmetros Nenhum
Resultado String Identificador do módulo
clsOperational.AssociateDocuments
Descrição Permite consultar documentos/imagens e efectuar a associação (ou não) ao documento/entidade PRIMAVERA em edição
Tipo Função
Parâmetros strErrors Descrição dos erros encontrados
strGUID Identificador do grupo de documentos/imagens
objFilter Filtro sobre o módulo, entidade e documento
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
11
lngHWND Handler da janela principal da aplicação PRIMAVERA
Resultado Boolean Indica se o método foi completado com sucesso
clsOperational.RemoveAssociation
Descrição Permite remover uma associação previamente efectuada (por exemplo, ao remover um documento/entidade PRIMAVERA)
Tipo Função
Parâmetros strErrors Descrição dos erros encontrados
strGUID Identificador da associação
lngHWND Handler da janela principal da aplicação PRIMAVERA
Resultado Boolean Indica se o método foi completado com sucesso
clsOperational.ViewDocuments
Descrição Permite visualizar o grupo de documentos/imagens associado a um documento/entidade PRIMAVERA
Tipo Função
Parâmetros strErrors Descrição dos erros encontrados
strGUID Identificador do grupo de documentos/imagens
lngHWND Handler da janela principal da aplicação PRIMAVERA
Resultado Boolean Indica se o método foi completado com sucesso
Métodos e Propriedades Opcionais
Os seguintes métodos e propriedades são opcionais.
clsOperational.CompanyId
Descrição Propriedade invocada pela Plataforma PRIMAVERA para passar o identificador da empresa activa antes de qualquer outra invocação
Tipo Propriedade
Parâmetros Nenhum
Resultado String Identificador da empresa (ex.: DEMO)
Compatibilidade
O componente de integração deve ser implementado com compatibilidade
binária:
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
12
Operações de Integração
“Acerca De”
Private Sub AcercaDe_Click()
Dim objAPI As Object
Set objAPI = CreateObject("ThrdDocSys.clsAbout")
Label1(0).Caption = objAPI.ApplicationName
Label1(1).Caption = objAPI.ApplicationVersion
Label1(2).Caption = objAPI.APIVersion
Label1(3).Caption = objAPI.Copyright
Set objAPI = Nothing
End Sub
“Operacional”
Private Sub OperationalAssociate_Click()
Dim objAPI As Object
Dim blnRes As Boolean
Dim strErrors As String
Dim strGUID As String
Dim objFilter As Object
Set objFilter = CreateObject("ThrdDocSys.clsFilter")
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
13
objFilter.ModuleId = strModIdCompras
objFilter.EntityType = "CLI"
objFilter.EntityName = "SOFRIO"
objFilter.DocumentType = "VFA"
Set objAPI = CreateObject("ThrdDocSys.clsOperational")
blnRes = objAPI.AssociateDocuments(strErrors, strGUID, objFilter,
Me.hWnd)
HandleErrors blnRes, strErrors
Set objFilter = Nothing
Set objAPI = Nothing
End Sub
Private Sub OperationalView_Click()
Dim objAPI As Object
Dim blnRes As Boolean
Dim strErrors As String
Set objAPI = CreateObject("ThrdDocSys.clsOperational")
blnRes = objAPI.ViewDocuments(strErrors, strGUIDAssociation,
Me.hWnd)
HandleErrors blnRes, strErrors
Set objAPI = Nothing
End Sub
Private Sub OperationalRemove_Click()
Dim objAPI As Object
Dim blnRes As Boolean
Dim strErrors As String
Set objAPI = CreateObject("ThrdDocSys.clsOperational")
blnRes = objAPI.RemoveAssociation(strErrors, strGUIDAssociation,
Me.hWnd)
HandleErrors blnRes, strErrors
Set objAPI = Nothing
End Sub
Configuração
A configuração da integração, nomeadamente, no que diz respeito à
enumeração de módulos e dos tipos de documentos e entidades disponíveis
para cada módulo é da responsabilidade do parceiro.
A PRIMAVERA fornecerá:
Uma lista fixa e limitada de módulos que integrarão, nos módulos
PRIMAVERA, as funcionalidades de GDOC;
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
14
Uma tabela de tipos de documentos e tipos de entidades associados a
cada um dos módulos (para classificação das imagens no sistema de
GDOC);
Exemplos da utilização dos motores dos módulos PRIMAVERA para
obter os valores possíveis para cada tipo de documento ou tipo de
entidade.
Usando esta informação, o parceiro deve implementar mecanismos de
integração dos motores PRIMAVERA DNA de modo a obter dinamicamente os
valores possíveis, no contexto de cada um dos módulos, para os tipos de
documentos e entidades.
Módulos PRIMAVERA
Os seguintes módulos PRIMAVERA implementam a integração com o sistema
de Gestão Documental:
Logística e Tesouraria
Módulo VND – Vendas
Nome Query
Entidades Clientes
SELECT Cliente, Nome FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente
Outros Devedores
SELECT Terceiro, Nome FROM OutrosTerceiros WHERE DevCred = 'D' AND Anulado = 0 ORDER BY Terceiro
Tipos Doc. Docs. Venda SELECT Documento, Descricao FROM DocumentosVenda ORDER BY Documento
Módulo CMP - Compras
Nome Query
Entidades Fornecedores
SELECT Fornecedor, Nome FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor
Outros Credores SELECT Terceiro, Nome FROM OutrosTerceiros WHERE DevCred = 'C' AND Anulado = 0 ORDER BY Terceiro
Tipos Doc. Docs. Compra SELECT Documento, Descricao FROM DocumentosCompra ORDER BY Documento
Módulo STK – Stocks
Nome Query
Entidades Armazéns
SELECT Armazem, Descricao FROM Armazens ORDER BY Armazem
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
15
Tipos Doc. Docs. Stock SELECT Documento, Descricao FROM DocumentosStk ORDER BY Documento
Módulo CCT – Contas Correntes
Nome Query
Entidades Clientes
SELECT Cliente, Nome FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente
Fornecedores SELECT Fornecedor, Nome FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor
Sócios/Accionistas SELECT Socio, Nome FROM Socios WHERE Anulado = 0 ORDER BY Socio
Estado SELECT EntidadePublica, Nome FROM EntidadesPublicas WHERE Anulado = 0 ORDER BY EntidadePublica
Outros Terceiros SELECT Terceiro, Nome FROM OutrosTerceiros WHERE Anulado = 0 ORDER BY Terceiro
Tipos Doc. Docs. CC SELECT Documento, Descricao FROM DocumentosCCT ORDER BY Documento
Módulo TES – Tesouraria
Nome Query
Entidades Clientes
SELECT Cliente, Nome FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente
Fornecedores SELECT Fornecedor, Nome FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor
Sócios/Accionistas SELECT Socio, Nome FROM Socios WHERE Anulado = 0 ORDER BY Socio
Estado SELECT EntidadePublica, Nome FROM EntidadesPublicas WHERE Anulado = 0 ORDER BY EntidadePublica
Outros Terceiros SELECT Terceiro, Nome FROM OutrosTerceiros WHERE Anulado = 0 ORDER BY Terceiro
Tipos Doc. Docs. Tesouraria SELECT Documento, Descricao FROM DocumentosTesouraria ORDER BY Documento
Módulo CLI – Clientes
Nome Query
Entidades Clientes
SELECT Cliente, Nome FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente
Tipos Doc. N/A N/A
Módulo FOR – Fornecedores
Nome Query
Entidades Fornecedores
SELECT Fornecedor, Nome FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor
Tipos Doc. N/A N/A
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
16
Módulo TER – Outros Terceiros
Nome Query
Entidades Outros Terceiros
SELECT Terceiro, Nome FROM OutrosTerceiros WHERE Anulado = 0 ORDER BY Terceiro
Tipos Doc. N/A N/A
Módulo SOC – Sócios/Accionistas
Nome Query
Entidades Sócios/Accionistas SELECT Socio, Nome FROM Socios WHERE Anulado = 0 ORDER BY Socio
Tipos Doc. N/A N/A
Módulo EST – Estado/Outros Entes Públicos
Nome Query
Entidades Estado SELECT EntidadePublica, Nome FROM EntidadesPublicas WHERE Anulado = 0 ORDER BY EntidadePublica
Tipos Doc. N/A N/A
Módulo ART – Artigos
Nome Query
Entidades Artigo <TODO>
Tipos Doc. N/A N/A
Módulo INT – Documentos Internos
Nome Query
Entidades As entidades configuradas para serem usadas nos documentos internos
Tipos Doc. Docs. Venda SELECT Documento, Descricao FROM DocumentosVenda ORDER BY Documento
Contabilidade
Módulo MOV – Movimentos Contabilísticos
Nome Query
Entidades Diários
SELECT Diario, Descricao FROM Diarios ORDER BY Diario
Tipos Doc. Documentos SELECT Documento, Descricao FROM DocumentosCBL ORDER BY Documento
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
17
Módulo CLI – Clientes
Nome Query
Entidades Clientes
SELECT Cliente, Nome FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente
Tipos Doc. N/A N/A
Módulo FOR – Fornecedores
Nome Query
Entidades Fornecedores
SELECT Fornecedor, Nome FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor
Tipos Doc. N/A N/A
Módulo TER – Outros Terceiros
Nome Query
Entidades Outros Terceiros
SELECT Terceiro, Nome FROM OutrosTerceiros WHERE Anulado = 0 ORDER BY Terceiro
Tipos Doc. N/A N/A
Equipamentos e Activos
Módulo FIC – Fichas de Equipamentos/Activos
Nome Query
Entidades Fichas de bens Select Ficha, Descricao From Fichas where Decomposicao = 0 ORDER BY Descricao
Tipos Doc. N/A N/A
Recursos Humanos
Módulo FUN – Funcionários
Nome Query
Entidades Funcionários Select Codigo, Nome FROM funcionarios ORDER BY Nome
Tipos Doc. N/A N/A
Módulo IND – Independentes
Nome Query
Entidades Independentes Select Codigo, Nome FROM funcionarios ORDER BY Nome
Tipos Doc. N/A N/A
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
18
Módulo ALT – Alterações Mensais
Nome Query
Entidades Funcionários SELECT Codigo, Nome FROM funcionarios ORDER BY Nome
Tipos Doc. N/A N/A
Módulo DES – Despesas
Nome Query
Entidades Despesas (Funcionário)
SELECT Codigo, Nome FROM funcionarios ORDER BY Nome
Tipos Doc. N/A N/A
Módulo FER – Férias
Nome Query
Entidades Férias (Funcionário)
SELECT Codigo, Nome FROM funcionarios ORDER BY Nome
Tipos Doc. N/A N/A
Tipos de Entidades
Os identificadores de tipos de entidades (correspondentes à propriedade
clsFilter.EntityType) são os seguintes:
Tipo de Entidade Identificador
Armazéns ARM
Clientes CLI
Estados EST
Fornecedores FOR
Outros Credores CRE
Outros Devedores DEV
Outros Terceiros TER
Sócios/Accionistas SOC
Artigo ART
Ficha de Equipamentos/Activos
FIC
Independente IND
Funcionário FUN
Despesas DES
Férias FER
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
19
Localização no ERP das integrações com a GDOC
No ERP PRIMAVERA existem diversos processos com a integração com a
tecnologia de Gestão Documental já pré-definida. Este subcapítulo pretende
discriminar esses processos por aplicação:
Contabilidade:
- Movimentos | Introdução de documentos;
- Tabelas | Clientes;
- Tabelas | Fornecedores;
Logística e Tesouraria:
- Documentos | Stocks;
- Documentos | Vendas;
- Documentos | Compras;
- Documentos | Contas Correntes;
- Documentos | Contas Correntes | Novos Documentos;
- Documentos | Tesouraria | Novos Documentos;
- Tabelas | Clientes;
- Tabelas | Fornecedores;
- Tabelas | Artigos | Ficha do Artigo;
- Documentos | Contas Correntes | Operações sobre Contas Correntes;
- Documentos | Vendas | Documentos Internos
Equipamentos e Activos:
- Tabelas | Ficha do Equipamento | Ficha Simples;
- Tabelas | Ficha do Equipamento | Ficha Completa;
Recursos Humanos:
- Tabelas | Funcionários | Ficha;
- Tabelas | Independentes / Outros | Fichas;
- Processamentos | Alterações Mensais | por Funcionário;
- Processamentos | Relatórios de Despesas | Introdução;
- Processamento | Férias.
Gabinetes:
- Tabelas | Clientes.
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
20
Sistema Gestão Documental integrando Aplicações Externas Este capítulo documenta a implementação do modelo conceptual nas
aplicações externas ao ERP PRIMAVERA, mas integradas. Tratam-se, por
exemplo, de aplicações desenvolvidas pelos Parceiros para solucionar
processos de negócios específicos e que se encontram integradas com o ERP
PRIMAVERA.
Ao contrário da situação apresentada no capítulo anterior, não é necessário
construir uma API de Integração (o componente ThrdDocSys) pois é possível
aceder às propriedades e funções disponíveis na Plataforma PRIMAVERA.
Plataforma – Interface de Gestão Documental
Este tópico documenta as funcionalidades disponibilizadas pela Plataforma
PRIMAVERA (v7.55 ou versões posteriores) às aplicações para integração da
solução de GDOC.
Plataforma.GestaoDocumental.InterfaceActivo
Descrição Indica se a Gestão Documental existe
Assinatura Public Property Get InterfaceActivo() As Boolean
Parâmetros N/A
Resultado Boolean
Invocação Deve ser invocada sempre antes da invocação de qualquer outro método para validar a instalação do interface
Plataforma.GestaoDocumental.InicializaModulo
Descrição Efectua a inicialização de um determinado módulo da aplicação com ligação à Gestão Documental (compras, vendas, etc.)
Assinatura Public Function InicializaModulo(ByVal strId As String, ByVal strNomeModulo
As String, ByVal objForm As Object, ByVal objActiveBar As Object, ByVal strNomeBanda As String) As Boolean
Parâmetros strId String GUID do módulo actual
strNomeModulo String Nome do módulo de acordo com a tabela de módulos (VND, CMP, etc.)
objForm Object Referência para a form que implementa o módulo
objActiveBar Object Referência para a ActiveBar onde serão
construídas dinamicamente as opções de ligação à Gestão Documental
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
21
strNomeBanda String Nome da banda da ActiveBar corresponde às operações de contexto
Resultado Boolean Indica se a inicialização foi efectuada com sucesso
Invocação Este método deve ser invocado no Form_Load da form que implementa o módulo da aplicação
Plataforma.GestaoDocumental.AssociaDocumentosEx
Descrição Efectua a associação de um documento do módulo da aplicação a uma ou mais imagens da Gestão Documental
Assinatura Public Function AssociaDocumentosEx(ByRef strIdDocumentos As String,
ByVal strId As String, Optional strTipoEntidade As String, Optional strEntidade As String = vbNullString, Optional strTipoDocumento As String) As Boolean
Parâmetros strIdDocumentos String GUID apontador para as imagens da Gestão
Documental devolvido pela aplicação externa após a associação
strId String GUID do módulo actual
strTipoEntidade String Tipo de entidade (ex.: FOR – fornecedores)
strEntidade String Entidade actual (ex.: fornecedor da compra actual)
strTipoDocumento String Tipo de documento actual (ex.: encomenda forn.)
Resultado Boolean Indica se a associação foi concluída com sucesso
Invocação Este método deve ser invocado quando o utilizador seleccionar a respectiva opção na toolbar (ActivBar_ToolClick)
Plataforma.GestaoDocumental.ConsultaDocumentos
Descrição Permite visualizar as imagens da Gestão Documental associadas previamente ao documento actual
Assinatura Public Function ConsultaDocumentos(ByVal strIdDocumentos As String, ByVal strId As String) As Boolean
Parâmetros strIdDocumentos String GUID apontador para as imagens da Gestão
Documental devolvido pela aplicação externa após a associação
strId String GUID do módulo actual
Resultado Boolean Indica se a consulta foi concluída com sucesso
Invocação Este método deve ser invocado quando o utilizador seleccionar a respectiva opção na toolbar (ActivBar_ToolClick)
Plataforma.GestaoDocumental.RemoveAssociacao
Descrição Permite remover a associação das imagens da Gestão Documental associadas previamente ao documento actual
Assinatura Public Function RemoveAssociacao(ByRef strIdDocumentos As String, ByVal strId As String) As Boolean
Parâmetros strIdDocumentos String GUID apontador para as imagens da Gestão
Documental devolvido pela aplicação externa após a associação (caso a remoção seja efectuada com sucesso este parâmetro ficará vazio)
strId String GUID do módulo actual
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
22
Resultado Boolean Indica se a remoção foi concluída com sucesso
Invocação Este método deve ser invocado quando o utilizador seleccionar a respectiva opção na toolbar (ActivBar_ToolClick)
Plataforma.GestaoDocumental.TerminaModulo
Descrição Termina um módulo da aplicação com ligação à Gestão Documental (compras, vendas, etc.)
Assinatura Public Function TerminaModulo(ByVal strId As String) As Boolean
Parâmetros strId String GUID do módulo actual (como passado em InicializaModulo)
Resultado Boolean Indica se o módulo foi terminado com sucesso
Invocação Este método deve ser invocado no Form_Unload da form que implementa o módulo da aplicação
NOTA: O método “AssociaDocumentos” foi descontinuado e não deve ser
utilizado.
Exemplo – Módulo de Compras (L&T) Este tópico apresenta um exemplo (simplificado) de implementação num dos
módulos da Logística e Tesouraria com ligação à Gestão Documental.
Inicialização do Módulo
Os módulos PRIMAVERA estão divididos em Compras, Vendas, etc., com
ligação à Gestão Documental. A inicialização do módulo corresponde às
seguintes operações:
Associação entre um GUID (do módulo) e o identificador (ex.: CMP)
do módulo;
Validação da instalação da Gestão Documental;
Passagem ao interface da Gestão Documental disponibilizado pela
Plataforma das referências necessárias para a ligação (activebar,
etc.);
Construção dinâmica das opções de ligação à Gestão Documental na
toolbar da aplicação.
Esta inicialização deve ser implementada na seguinte forma:
Identificador do Módulo
O identificador do módulo será armazenado como uma variável global ao
formulário que implementa o módulo PRIMAVERA (Compras no exemplo):
Private m_strIdGDOC As String
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
23
Invocação de InicializaModulo
Esta invocação deve ser realizada no evento Form_Load da form
(frmDocCompras no exemplo):
Private Sub Form_Load()
(...)
m_strIdGDOC = Plataforma.FuncoesGlobais.CriaGuid(True)
Plataforma.GestaoDocumental.InicializaModulo m_strIdGDOC, “CMP”,
Me, ActiveBar, “PopMovOutras”
End Sub
NOTAS:
O parâmetro strNomeModulo deve corresponder ao identificador oficial do
módulo (ver capítulo “Módulos PRIMAVERA”);
O parâmetro objForm deve ser uma referência para a form actual;
O parâmetro objActiveBar deve ser uma referência para a toolbar da form
actual;
O parâmetro strNomeBanda deve corresponder ao nome da banda que
implemente as operações de contexto da form;
O valor da variável m_strIdGDOC deve ser utilizado em todas as
invocações do interface de Gestão Documental da Plataforma para
identificar o módulo da aplicação activo.
Construção das Opções na Toolbar (Contexto)
Sempre que o interface externo de Gestão Documental estiver devidamente
instalado, os módulos com integração apresentarão as seguintes opções no
menu de contexto:
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
24
Finalização do Módulo
A finalização do módulo corresponde à libertação de variáveis na Plataforma e
deve ser invocada no evento Form_Unload da form que implemente o módulo
da aplicação:
Private Sub Form_Unload(Cancel As Integer)
(...)
Plataforma.GestaoDocumental.TerminaModulo m_strIdGDOC
End Sub
Associação de Imagens
A associação de imagens permite que sejam agregadas uma ou mais imagens
ao documento activo no módulo da aplicação.
O utilizador poderá criar uma nova associação ou alterar a associação
previamente existente.
Essa associação será representada por GUID único (definido pela aplicação
externa).
Esta operação deve ser invocada quando o utilizador seleccionar a respectiva
opção na toolbar.
ActiveBar_ToolClick
Private Sub ActiveBar_ToolClick(ByVal Tool As
ActiveBar2LibraryCtl.Tool)
(...)
Select Case Tool.Name
Case “mnuGDOC_Associar”
GDOC_Associar
(...)
End Select
(...)
End Sub
GDOC_Associar
Private Sub GDOC_Associar()
Dim strIdDocs As String
On Error GoTo Erro
„Gestão Documental instalada?
If Plataforma.GestaoDocumental.InterfaceActivo Then
„Validações
If (CmbTipoDoc.ListIndex >= 0) Then
If (Len(Fornecedor.Text) > 0) Then
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
25
„Execução
strIdDocs = txtGUID.Text „O Id deve ser carregado da
base de dados
If
Plataforma.GestaoDocumental.AssociaDocumentosEx(strIdDocs,
m_strIdGDOC, “FOR”, Fornecedor.Text, CmbTipoDoc.Text) Then
txtGUID.Text = strIdDocs „O Id deve ser gravado na
base de dados
End If
Else
Plataforma.Dialogos.MostraAviso “Não seleccionou a
entidade.”
End If
Else
Plataforma.Dialogos.MostraAviso “Não seleccionou a tipo de
documento.”
End If
End If
Exit Sub
Erro:
StdAplMostraErro “Erro ao associar documentos da Gestão
Documental.”
End Sub
NOTAS:
- A aplicação deve implementar todas as validações necessárias antes de
invocar o interface da Plataforma (ex.: existe um documento em edição?);
- Os parâmetros strTipoEntidade, strEntidade e strTipoDocumento do
método AssociaDocumentosEx permitem que a aplicação externa apresente as
imagens existentes no sistema filtradas de acordo com o contexto activo
(módulo, entidade e tipo de documento);
- O valor do parâmetro strTipoEntidade dependerá do tipo de
entidade seleccionado pelo utilizador (ex.: nas vendas pode ser
Clientes ou Fornecedores) e deve corresponder à tabela de tipos de
entidades válidos (ver Capítulo “Tipos de Entidades”).
- O GUID da associação é devolvido pelo parâmetro strIdDocumentos.
Visualização de Imagens
Esta operação permite ao utilizador visualizar todas as imagens previamente
associadas ao documento activo.
Esta operação deve ser invocada quando o utilizador seleccionar a respectiva
opção na toolbar.
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
26
ActiveBar_ToolClick
Private Sub ActiveBar_ToolClick(ByVal Tool As
ActiveBar2LibraryCtl.Tool)
(...)
Select Case Tool.Name
Case “mnuGDOC_Visualizar”
GDOC_Visualizar
(...)
End Select
(...)
End Sub
GDOC_Visualizar
Private Sub GDOC_Visualizar()
Dim strIdDocs As String
On Error GoTo Erro
„Gestão Documental instalada?
If Plataforma.GestaoDocumental.InterfaceActivo Then
„Validações
If (Len(txtGUID.Text) > 0) Then
„Execução
strIdDocs = txtGUID.Text
Plataforma.GestaoDocumental.ConsultaDocumentos strIdDocs,
m_strIdGDOC
Else
Plataforma.Dialogos.MostraAviso “Não existe nenhuma
associação a documentos da Gestão Documental para o documento actual.”
End If
End If
Exit Sub
Erro:
StdAplMostraErro “Erro ao visualizar as documentos da Gestão
Documental.”
End Sub
NOTAS:
- A aplicação deve implementar todas as validações necessárias antes de
invocar o interface da Plataforma (ex.: existe um documento em edição?,
existe uma associação previamente efectuada?);
- O parâmetro strIdDocumentos identifica a associação a visualizar.
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
27
Remoção da Associação
Esta operação permite ao utilizador remover uma associação previamente
existente.
Deve ser invocada quando o utilizador seleccionar a respectiva opção na
toolbar.
ActiveBar_ToolClick
Private Sub ActiveBar_ToolClick(ByVal Tool As
ActiveBar2LibraryCtl.Tool)
(...)
Select Case Tool.Name
Case “mnuGDOC_Remover”
GDOC_Remover
(...)
End Select
(...)
End Sub
GDOC_Remover
Private Sub GDOC_Remover()
Dim strIdDocs As String
On Error GoTo Erro
„Gestão Documental instalada?
If Plataforma.GestaoDocumental.InterfaceActivo Then
„Validações
If (Len(txtGUID.Text) > 0) Then
„Execução
strIdDocs = txtGUID.Text
If Plataforma.GestaoDocumental.RemoveAssociacao(strIdDocs,
m_strIdGDOC) Then
Plataforma.Dialogos.MostraAviso “Associação removida
com sucesso.”
txtGUID.Text = strIdDocs
End If
Else
Plataforma.Dialogos.MostraAviso “Não existe nenhuma
associação a documentos da Gestão Documental para o documento actual.”
End If
End If
Exit Sub
Erro:
StdAplMostraErro “Erro ao remover a associação a documentos da
Gestão Documental.”
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
28
End Sub
NOTAS:
- A aplicação deve implementar todas as validações necessárias antes de
invocar o interface da Plataforma (ex.: existe um documento em edição?,
existe uma associação prévia?);
- O parâmetro strIdDocumentos identifica a associação a remover;
- A anulação de um documento na aplicação (ex.: factura) deve
implementar a remoção de qualquer associação que exista
previamente para o documento.
Base de Dados
O identificador de associações gerado pela aplicação externa de Gestão
Documento (parâmetro strIdDocumentos) deve ser armazenado na base de
dados, no cabeçalho do documento e na forma de um campo (não obrigatório)
do tipo uniqueidentifier.
Recomenda-se que este tipo de campos tenha a seguinte definição:
Nome IdGDOC
Tipo uniqueidentifier
Obrigatório Não
Naturalmente, é necessário ainda que o motor da aplicação PRIMAVERA
implemente o campo como um novo atributo da entidade em causa (ex.:
documento de compra).
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
29
Exemplo Neste capítulo é apresentado um pequeno exemplo que ilustra o processo de
associação de imagens no módulo de Vendas.
Digitalização da Imagem Usando a ferramenta respectiva de GDOC uma ou mais imagens são
digitalizadas e adicionadas a um lote.
Classificação De acordo com os dados do documento este será devidamente classificado de
acordo com os módulos, entidades e documentos PRIMAVERA. Esta
classificação é efectuada no sistema GDOC a partir dos lotes digitalizados.
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
30
Workflow Dependendo da solução GDOC, é possível existir vários passos na validação
dos documentos.
Criação da Factura Na Logística e Tesouraria, o utilizador introduz um novo documento.
PKB
Documentos de Venda
Associação A partir do momento em que os dados mínimos tenham sido introduzidos no
editor de vendas, o utilizador poderá utilizar o menu de contexto para associar
a imagem anteriormente digitalizada e classificada.
Gestão Documental – Manual de Integração
PRIMAVERA – Business Software Solutions, S.A.
Este documento é propriedade da PRIMAVERA BSS, S.A. não podendo ser reproduzido sem a sua autorização
expressa.
31