Manual de Integração INTERFACE GESTÃO DOCUMENTAL PLATAFORMA PRIMAVERA

Transcrição

1 Manual de Integração INTERFACE GESTÃO DOCUMENTAL PLATAFORMA PRIMAVERA Versão 1.0 março 2013

2 Índice Índice... 2 Introdução... 5 Sistema Gestão Documental integrando Plataforma PRIMAVERA... 6 Modelo Conceptual...6 Modelo Funcional...7 Funcionalidades... 7 Ativação do Serviço nos Módulos PRIMAVERA... 8 Componente de Integração... 8 Propriedades do Componente... 8 Classes Necessárias... 9 Métodos e Propriedades Obrigatórios... 9 clsabout.applicationname clsabout.applicationversion clsabout.apiversion clsabout.copyright clsfilter.documenttype clsfilter.entitytype clsfilter.entityname clsfilter.moduleid clsoperational.associatedocuments clsoperational.removeassociation clsoperational.viewdocuments Métodos e Propriedades Opcionais clsoperational.companyid Compatibilidade Operações de Integração Acerca De Operacional Configuração Módulos PRIMAVERA Logística e Tesouraria Pg 2

3 Módulo VND Vendas Módulo CMP - Compras Módulo STK Stocks Módulo CCT Contas Correntes Módulo TES Tesouraria Módulo CLI Clientes Módulo FOR Fornecedores Módulo TER Outros Terceiros Módulo SOC Sócios/Acionistas Módulo EST Estado/Outros Entes Públicos Módulo ART Artigos Módulo INT Documentos Internos Contabilidade Módulo MOV Movimentos Contabilísticos Módulo CLI Clientes Módulo FOR Fornecedores Módulo TER Outros Terceiros Equipamentos e Ativos Módulo FIC Fichas de Equipamentos/Ativos Recursos Humanos Módulo FUN Funcionários Módulo IND Independentes Módulo ALT Alterações Mensais Módulo DES Despesas Módulo FER Férias Tipos de Entidades Localização no ERP das integrações com a GDOC Sistema Gestão Documental integrando Aplicações Externas Plataforma Interface de Gestão Documental Plataforma.GestaoDocumental.InterfaceActivo Plataforma.GestaoDocumental.InicializaModulo Plataforma.GestaoDocumental.AssociaDocumentosEx Plataforma.GestaoDocumental.ConsultaDocumentos Plataforma.GestaoDocumental.RemoveAssociacao Pg 3

4 Plataforma.GestaoDocumental.TerminaModulo Exemplo Módulo de Compras (L&T) Inicialização do Módulo Identificador do Módulo Invocação de InicializaModulo Construção das Opções na Toolbar (Contexto) Finalização do Módulo Associação de Imagens ActiveBar_ToolClick GDOC_Associar Visualização de Imagens ActiveBar_ToolClick GDOC_Visualizar Remoção da Associação ActiveBar_ToolClick GDOC_Remover Base de Dados Exemplo Digitalização da Imagem Classificação Workflow Associação Pg 4

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 8.10 (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 online 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. De modo a consultar a versão mais atualizada deste manual, sugere-se a sua consulta online na PRIMAVERA KnowledgeBase. PKB Manual de Instalação v8.10 Manual de Migração v8.10 Pg 5

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 aspetos 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 Pg 6

7 interface pré-definido (descrito no capítulo Modelo Funcional ) que ativará as funções de Gestão Documental nos módulos PRIMAVERA instaladas; Toda a comunicação entre os módulos PRIMAVERA e a aplicação de Gestão Documental será efetuada a partir da Plataforma PRIMAVERA através das classes, métodos e propriedades definidas no componente que implementa a API de integração. Na perspetiva 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 respetivas operações e ativaçõ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 efetuar, ou não, a associação ao documento/entidade PRIMAVERA; Digitalização/Associação : digitalização on demand de documentos com possibilidade de efetuar, ou não, a associação ao documento/entidade PRIMAVERA; Visualização : visualização on demand dos documentos (imagens) associados ao documento/entidade PRIMAVERA. Pg 7

8 Ativação do Serviço nos Módulos PRIMAVERA As funcionalidades de GDOC serão automaticamente ativadas 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 Pg 8

9 Classes Necessárias Devem existir as seguintes classes: clsabout: objeto de informação sobre a aplicação e API de GDOC; clsfilter: objeto de definição de filtros de pesquisa de documentos/imagens; clsoperational: objeto 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 efetuada devem ser implementados em cada uma das classes anteriores. Pg 9

10 clsabout.applicationname Descrição Devolve o nome da aplicação Tipo Propriedade Parâmetros Nenhum Resultado String 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 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 da entidade Pg 10

11 clsfilter.entityname Descrição da entidade PRIMAVERA (SOFRIO, ALCAD, etc.) Tipo Propriedade Parâmetros Nenhum Resultado String 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 Descrição Tipo clsoperational.associatedocuments Permite consultar documentos/imagens e efetuar a associação (ou não) ao documento/entidade PRIMAVERA em edição Função Parâmetros strerrors Descrição dos erros encontrados strguid objfilter lnghwnd Identificador do grupo de documentos/imagens Filtro sobre o módulo, entidade e documento Handler da janela principal da aplicação PRIMAVERA Resultado Boolean Indica se o método foi completado com sucesso Descrição Tipo clsoperational.removeassociation Permite remover uma associação previamente efetuada (por exemplo, ao remover um documento/entidade PRIMAVERA) Função Parâmetros strerrors Descrição dos erros encontrados strguid lnghwnd Identificador da associação Handler da janela principal da aplicação PRIMAVERA Resultado Boolean Indica se o método foi completado com sucesso Descrição Tipo clsoperational.viewdocuments Permite visualizar o grupo de documentos/imagens associado a um documento/entidade PRIMAVERA Função Parâmetros strerrors Descrição dos erros encontrados strguid Identificador do grupo de documentos/imagens Pg 11

12 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. Descrição Tipo Parâmetros clsoperational.companyid Propriedade invocada pela Plataforma PRIMAVERA para passar o identificador da empresa ativa antes de qualquer outra invocação Propriedade Nenhum Resultado String Identificador da empresa (ex.: DEMO) Compatibilidade O componente de integração deve ser implementado com compatibilidade binária: Pg 12

13 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") 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 Pg 13

14 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. Uma lista fixa e limitada de módulos que integrarão, nos módulos PRIMAVERA, as funcionalidades de GDOC; 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. Pg 14

15 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 Entidades Clientes SELECT Cliente, FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente Outros Devedores SELECT Terceiro, 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 Entidades Fornecedores SELECT Fornecedor, FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor Outros Credores SELECT Terceiro, 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 Entidades Armazéns SELECT Armazem, Descricao FROM Armazens ORDER BY Armazem Tipos Doc. Docs. Stock SELECT Documento, Descricao FROM DocumentosStk ORDER BY Documento Módulo CCT Contas Correntes Entidades Clientes SELECT Cliente, FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente Fornecedores Sócios/Acionistas SELECT Fornecedor, FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor SELECT Socio, FROM Socios WHERE Anulado = 0 ORDER BY Socio Pg 15

16 Estado SELECT EntidadePublica, FROM EntidadesPublicas WHERE Anulado = 0 ORDER BY EntidadePublica Outros Terceiros SELECT Terceiro, FROM OutrosTerceiros WHERE Anulado = 0 ORDER BY Terceiro Tipos Doc. Docs. CC SELECT Documento, Descricao FROM DocumentosCCT ORDER BY Documento Módulo TES Tesouraria Entidades Clientes SELECT Cliente, FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente Fornecedores Sócios/Acionistas Estado SELECT Fornecedor, FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor SELECT Socio, FROM Socios WHERE Anulado = 0 ORDER BY Socio SELECT EntidadePublica, FROM EntidadesPublicas WHERE Anulado = 0 ORDER BY EntidadePublica Outros Terceiros SELECT Terceiro, FROM OutrosTerceiros WHERE Anulado = 0 ORDER BY Terceiro Tipos Doc. Docs. Tesouraria SELECT Documento, Descricao FROM DocumentosTesouraria ORDER BY Documento Módulo CLI Clientes Entidades Clientes SELECT Cliente, FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente Tipos Doc. N/A N/A Módulo FOR Fornecedores Entidades Fornecedores SELECT Fornecedor, FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor Tipos Doc. N/A N/A Módulo TER Outros Terceiros Entidades Outros Terceiros SELECT Terceiro, FROM OutrosTerceiros WHERE Anulado = 0 ORDER BY Terceiro Tipos Doc. N/A N/A Pg 16

17 Módulo SOC Sócios/Acionistas Entidades Sócios/Acionistas SELECT Socio, FROM Socios WHERE Anulado = 0 ORDER BY Socio Tipos Doc. N/A N/A Módulo EST Estado/Outros Entes Públicos Entidades Estado SELECT EntidadePublica, FROM EntidadesPublicas WHERE Anulado = 0 ORDER BY EntidadePublica Tipos Doc. N/A N/A Módulo ART Artigos Entidades Artigo <TODO> Tipos Doc. N/A N/A Entidades Módulo INT Documentos Internos As entidades configuradas para serem usadas nos documentos internos Tipos Doc. Docs. Venda SELECT Documento, Descricao FROM DocumentosVenda ORDER BY Documento Pg 17

18 Contabilidade Módulo MOV Movimentos Contabilísticos Entidades Diários SELECT Diario, Descricao FROM Diarios ORDER BY Diario Tipos Doc. Documentos SELECT Documento, Descricao FROM DocumentosCBL ORDER BY Documento Módulo CLI Clientes Entidades Clientes SELECT Cliente, FROM Clientes WHERE ClienteAnulado = 0 ORDER BY Cliente Tipos Doc. N/A N/A Módulo FOR Fornecedores Entidades Fornecedores SELECT Fornecedor, FROM Fornecedores WHERE FornecedorAnulado = 0 ORDER BY Fornecedor Tipos Doc. N/A N/A Módulo TER Outros Terceiros Entidades Outros Terceiros SELECT Terceiro, FROM OutrosTerceiros WHERE Anulado = 0 ORDER BY Terceiro Tipos Doc. N/A N/A Pg 18

19 Equipamentos e Ativos Módulo FIC Fichas de Equipamentos/Ativos 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 Entidades Funcionários Select Codigo, FROM funcionarios ORDER BY Tipos Doc. N/A N/A Módulo IND Independentes Entidades Independentes Select Codigo, FROM funcionarios ORDER BY Tipos Doc. N/A N/A Módulo ALT Alterações Mensais Entidades Funcionários SELECT Codigo, FROM funcionarios ORDER BY Tipos Doc. N/A N/A Entidades Módulo DES Despesas Despesas (Funcionário) Tipos Doc. N/A N/A SELECT Codigo, FROM funcionarios ORDER BY Módulo FER Férias Entidades Férias (Funcionário) SELECT Codigo, FROM funcionarios ORDER BY Tipos Doc. N/A N/A Pg 19

20 Tipos de Entidades Os identificadores de tipos de entidades (correspondentes à propriedade clsfilter.entitytype) são os seguintes: Tipo de Entidade Armazéns Clientes Estados Fornecedores Outros Credores Outros Devedores Outros Terceiros Sócios/Accionistas Artigo Ficha de Equipamentos/Ativos Independente Funcionário Despesas Férias Identificador ARM CLI EST FOR CRE DEV TER SOC ART FIC IND FUN DES FER 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; Pg 20

21 - 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 Ativos: - 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. Pg 21

22 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 (v8.10 ou versões posteriores) às aplicações para integração da solução de GDOC. Plataforma.GestaoDocumental.InterfaceActivo Descrição Assinatura Parâmetros Resultado Invocação Indica se a Gestão Documental existe Public Property Get InterfaceActivo() As Boolean N/A Boolean Deve ser invocada sempre antes da invocação de qualquer outro método para validar a instalação do interface Descrição Assinatura Plataforma.GestaoDocumental.InicializaModulo Efetua a inicialização de um determinado módulo da aplicação com ligação à Gestão Documental (compras, vendas, etc.) Public Function InicializaModulo(ByVal strid As String, ByVal strmodulo As String, ByVal objform As Object, ByVal objactivebar As Object, ByVal strbanda As String) As Boolean Parâmetros strid String GUID do módulo atual strmodulo String 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 strbanda String da banda da ActiveBar corresponde às operações de contexto Pg 22

23 Resultado Boolean Indica se a inicialização foi efetuada com sucesso Invocação Este método deve ser invocado no Form_Load da form que implementa o módulo da aplicação Descrição Assinatura Plataforma.GestaoDocumental.AssociaDocumentosEx Efetua a associação de um documento do módulo da aplicação a uma ou mais imagens da Gestão Documental 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 atual strtipoentidade String Tipo de entidade (ex.: FOR fornecedores) strentidade String Entidade atual (ex.: fornecedor da compra atual) strtipodocumento String Tipo de documento atual (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 selecionar a respetiva opção na toolbar (ActivBar_ToolClick) Descrição Assinatura Plataforma.GestaoDocumental.ConsultaDocumentos Permite visualizar as imagens da Gestão Documental associadas previamente ao documento atual 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 atual Resultado Boolean Indica se a consulta foi concluída com sucesso Invocação Este método deve ser invocado quando o utilizador selecionar a respetiva opção na toolbar (ActivBar_ToolClick) Pg 23

24 Descrição Assinatura Plataforma.GestaoDocumental.RemoveAssociacao Permite remover a associação das imagens da Gestão Documental associadas previamente ao documento atual 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 efetuada com sucesso este parâmetro ficará vazio) strid String GUID do módulo atual Resultado Boolean Indica se a remoção foi concluída com sucesso Invocação Este método deve ser invocado quando o utilizador selecionar a respetiva opção na toolbar (ActivBar_ToolClick) Descrição Assinatura Plataforma.GestaoDocumental.TerminaModulo Termina um módulo da aplicação com ligação à Gestão Documental (compras, vendas, etc.) Public Function TerminaModulo(ByVal strid As String) As Boolean Parâmetros strid String GUID do módulo atual (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 Pg 24

25 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 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 strmodulo 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 atual; Pg 25

26 O parâmetro objactivebar deve ser uma referência para a toolbar da form atual; O parâmetro strbanda 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 ativo. 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: 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 Pg 26

27 Associação de Imagens A associação de imagens permite que sejam agregadas uma ou mais imagens ao documento ativo 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 selecionar a respetiva opção na toolbar. ActiveBar_ToolClick Private Sub ActiveBar_ToolClick(ByVal Tool As ActiveBar2LibraryCtl.Tool) (...) Select Case Tool.Name Case mnugdoc_associar (...) End Select (...) End Sub GDOC_Associar GDOC_Associar Private Sub GDOC_Associar() Dim striddocs dados 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 Execução striddocs = txtguid.text O Id deve ser carregado da base de If Plataforma.GestaoDocumental.AssociaDocumentosEx(strIdDocs, m_stridgdoc, FOR, Fornecedor.Text, CmbTipoDoc.Text) Then dados Else Else End If End If txtguid.text = striddocs O Id deve ser gravado na base de Plataforma.Dialogos.MostraAviso Não selecionou a entidade. Plataforma.Dialogos.MostraAviso Não selecionou a tipo de documento. Pg 27

28 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 ativo (módulo, entidade e tipo de documento); - O valor do parâmetro strtipoentidade dependerá do tipo de entidade selecionado 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 ativo. Esta operação deve ser invocada quando o utilizador selecionar a respetiva opção na toolbar. ActiveBar_ToolClick Private Sub ActiveBar_ToolClick(ByVal Tool As ActiveBar2LibraryCtl.Tool) (...) Select Case Tool.Name Case mnugdoc_visualizar GDOC_Visualizar (...) End Select (...) End Sub Pg 28

29 GDOC_Visualizar Private Sub GDOC_Visualizar() Dim striddocs As String On Error GoTo Erro Gestão Documental instalada? If Plataforma.GestaoDocumental.InterfaceActivo Then m_stridgdoc Validações If (Len(txtGUID.Text) > 0) Then Else Execução striddocs = txtguid.text Plataforma.GestaoDocumental.ConsultaDocumentos striddocs, Plataforma.Dialogos.MostraAviso Não existe nenhuma associação a documentos da Gestão Documental para o documento atual. Erro: End If End Sub End If Exit Sub StdAplMostraErro Erro ao visualizar as documentos da Gestão Documental. 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 efetuada?); - O parâmetro striddocumentos identifica a associação a visualizar. Remoção da Associação Esta operação permite ao utilizador remover uma associação previamente existente. Deve ser invocada quando o utilizador selecionar a respetiva 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 (...) Pg 29

30 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 sucesso. Else End If Plataforma.Dialogos.MostraAviso Associação removida com txtguid.text = striddocs Plataforma.Dialogos.MostraAviso Não existe nenhuma associação a documentos da Gestão Documental para o documento atual. Erro: End If End If Exit Sub StdAplMostraErro Erro ao remover a associação a 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 prévia?); - O parâmetro striddocumentos identifica a associação a remover; - A anulação de um documento na aplicação (ex.: fatura) 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: Pg 30

31 Tipo Obrigatório IdGDOC uniqueidentifier 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). 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 respetiva de GDOC uma ou mais imagens são digitalizadas e adicionadas a um lote. Pg 31

32 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 é efetuada no sistema GDOC a partir dos lotes digitalizados. Workflow Na Logística e Tesouraria, o utilizador introduz um novo documento. PKB Documentos de Venda Pg 32

33 Associação Pg 33

34 Pg 34