Histórico da Página
INTEGRAÇÃO
FLUIGFluig \ GED X
PROTHEUSMicrosiga Protheus®\SIGAJURI
Contexto de negócio (Introdução)
Agora os anexos de assuntos jurídicosAssuntos Jurídicos, andamentos Andamentos, follow Follow-ups e garantias Garantias também poderão podem ser anexados diretamente no FLUIGFluig.
Será alterada Ajustada a rotina de que permite anexar documentos jurídicos, para permitir a integração com o GED do FLUIGFluig.
A execução da rotina de integração será executada em tempo real, mas também será preparada para pode ser executada via Schedule.
Sistemas Envolvidos
Descrição dos sistemas envolvidos no contexto de negócio (e que serão também envolvidos na integração).
- FLUIGFluig\GED - No gerenciamento de documentos ele oferece alternativas confiáveis e práticas na gestão de conteúdo.
- TOTVS\Protheus Microsiga Protheus® - O ERP engloba o modulo módulo Gestão Jurídica (SIGAJURI) para atender os departamentos jurídicos de empresas, e tem como um de seus principais objetivos, o controle de documentos por Caso / Processo.
Integração
O objetivo principal é a integração do Gestão Jurídica (SIGAJURI) com o FLUIG Fluig permitindo que:
- Os arquivos anexos relacionados aos assuntos jurídicosAssuntos Jurídicos, andamentosAndamentos, followFollow-ups ou garantias Garantias, sejam anexados diretamente no FLUIGFluig;
- Controle das pastas por assuntos jurídicos Assuntos Jurídicos e casosCasos;
- Segurança no acesso aos arquivos e pastas definidas por usuários;
Esse foi uma melhoraria Esta melhoria é disponibilizada pela equipe do Gestão Jurídica. Porque hoje o , em função de hoje termos o controle de documentos pode ser feito pelo Banco de Conhecimento e pelo Worksite.
Com essa esta integração será é possível efetuar esse este controle também pelo FLUIGFluig.
O que levou a criação da integração / o porquê da integração (Finalidade/Objetivo), de forma macro, o que será integrado do, por exemplo, Vertical com o ERP (BackOffice)
Explique o contexto de negócio ou do problema na qual esta integração estará inserida. Isto inclui o funcionamento da(s) ponta(s) envolvida(s).
Apresentar a integração como uma melhoria para o cenário ou como uma solução para o problema.
- Premissas
Gerais, do Vertical, do BackOffice e dos demais artefatos/sistemas envolvidos
Premissas Gerais
Premissas A
Premissas B
- Arquitetura (Tecnologia)
Escopo
A proposta da integração viabiliza aos usuários FLUIG e do SIGAJURI ferramentas que auxiliam no controle de documento por caso
Resumindo, quando um usuário criar um processo\caso no SIGAJURI, uma pasta será criada em documentos do FLUIG dentro do assunto jurídico tratado pelo processo e todos os documentos serão anexados nesta pasta.
Descreva, dado o contexto, qual o escopo de atuação da integração. Cite as áreas/perfis de usuários e funções impactadas. Se existe uma parte do contexto de negócio que a integração não tenta resolver, deixe explícito.
Defina exatamente o que a integração FAZ, o que ela NÃO FAZ e a sua finalidade.
[O conteúdo poderá estar disponível na ferramenta PMS – Painel de Gestão de Projetos, opção Plano do Projeto]
Como são os processos os que serão integrados, mas com uma visão geral e não só o ponto de integração caso contrário a homologação [ou outro que pegar o documento] não saberá do que se trata no sistema vertical, de forma sucinta, como funciona e o(s) ponto(s) de integração.
Citar a responsabilidade de cada produto.
Descrever com mais detalhes sobre o que será integrado (mas não ser especialista nas entidades/processos, pois suas particularidades serão descritas posteriormente) incluindo diagramas, prints, imagens, etc o que for interessante para auxiliar o entendimento.
Interessante aqui a inclusão de diagramas, imagens, lógicas, fluxo(s) do(s) processo(s) o que considerar interessante e agregador ao documento e ao escopo.
Pré-requisitos instalação/implantação/utilização
Relacione quais são os pré-requisitos (técnicos ou de negócio) para a integração. Este tópico não deve incluir informações da implantação normal do módulo, mas apenas informações específicas da integração. É como se este tópico já partisse do princípio que o módulo que será integrado já está normalmente instalado.
Entre os tópicos deste tópico podemos citar:
- Versões mínimas de produtos.
- Módulos ou programas que geram informações necessárias a integração. Muitas vezes a integração partirá de informações que somente são trabalhadas em um determinado programa ou processo, que deverá estar em uso no cliente.
- Ferramentas que são necessárias a integração, como: EAI, ESB, servidor de WebService etc.
- Aspectos legais nos quais as partes envolvidas na integração devem estar inseridas, caso as informações envolvidas sejam utilizadas para o cumprimento de alguma lei específica.
- Requisitos de hardware ou Software, como servidores, link de internet, capacidade de armazenamento e memória, sistema operacional.
Datasul
Insira aqui as informações pertinentes a Datasul.
Logix
Insira aqui as informações pertinentes ao Logix.
Protheus
Insira aqui as informações pertinentes ao Protheus.
RM
Insira aqui as informações pertinentes ao RM.
Instalação/Atualização
Este tópico tem por objetivo orientar a instalação da integração, visando o seu funcionamento completo. Instalação de produtos ou ferramentas necessárias podem referenciar outros documentos existentes, desde que estejam disponíveis no repositório de documentação da TOTVS ou sejam enviados junto com o documento da integração em si. As informações mínimas necessárias para teste tópico são:
- Procedimentos que devem ser observados quando um dos produtos for atualizado.
- Configuração necessária que deve ser realizada em arquivos de configuração ou programas de parâmetros etc.
- Arquivos diversos que devem ser mantidos em determinados locais para o funcionamento da integração, exemplo: xml, xsd.
- Atualizações necessárias em banco de dados ou instruções para que elas sejam feitas.
- Processos, módulos ou programas que precisam ser instalados ou atualizados. Deve ser definida a versão mínima necessária dos programas envolvidos.
- Ferramentas, servidores ou serviços que precisam ser disponibilizados e configurados, o que pode gerar necessidade de novo hardware ou aumento de capacidade. Exemplo: serviço de WebService.
- Instruções para habilitar a comunicação da ferramenta EAI entre as partes, quais rotas devem ser definidas ou como as transações devem ser habilitadas.
Observação: evite o uso de Prints de telas, facilitando, assim, o trabalho de tradução e versionamento deste documento.
Datasul
Insira aqui as informações pertinentes a Datasul.
Logix
Insira aqui as informações pertinentes ao Logix.
Protheus
Insira aqui as informações pertinentes ao Protheus.
RM
Insira aqui as informações pertinentes ao RM.
Escopo
Esta integração viabiliza aos usuários do Fluig e do Microsiga Protheus® ferramentas que auxiliam no controle de documento por caso.
E será utilizada pelo Microsiga Protheus®, pelo módulo Gestão Jurídica (SIGAJURI) para o armazenamento, compartilhamento e interação de documentos utilizados nos processos do SIGAJURI.
Com isso os usuários tem acesso aos documentos de qualquer lugar, sem necessitar de interações diretamente com o Microsiga Protheus®.
A integração funciona da seguinte maneira:
- Ao criar um Processo\Caso no SIGAJURI, uma pasta é criada em Documentos dentro do Fluig.
- No FLUIG, na pasta criada, são anexados todos os documentos referente a esse Processo\Caso.
Pré-requisitos instalação/implantação/utilização
Serão tratados pelos sistemas individualmente nos tópicos abaixo.
Datasul
Não se aplica.
Logix
Não se aplica.
Protheus
Acesse o módulo do configurador e confira os parâmetros abaixo:
- Atualize pelo configurador o Parâmetro MV_JDOCUME configurado com a opção 3 que significa Fluig;
- Atualize pelo configurador o Parâmetro MV_JDOCPAI configurado com o número da pasta raiz do Fluig;
- Atualize pelo configurador o Parâmetro MV_JFLSUBP configurado com os nomes das Pastas que devem ser criadas depois da pasta do Caso;
- Atualize pelo configurador o Parâmetro MV_ECMURL configurado com o nome ou IP do servidor Fluig; Parâmetro MV_ECMURL deve conter a palavra webdesk entre "/" (barras). Exemplo: http//:127.0.01:8080/webdesk/
- Atualize pelo configurador o Parâmetro MV_ ECMUSER configurado com o usuário administrador do servidor Fluig;
- Atualize pelo configurador o Parâmetro MV_ ECMPWD configurado com a senha do administrador do servidor Fluig;
- Atualize pelo configurador o Parâmetro MV_ ECMEMP configurado com o código da Empresa utilizada no Fluig;
- Atualize pelo configurador os usuários, o campo e-mail deve ser o usado para acesso no Fluig.
Acesse o módulo do configurador e confira a criação das tabelas abaixo:
- Tabela NZ7 – Casos GED é a tabela responsável por gravar os Casos com os campos que definem os documentos no Fluig.
- Tabela NYB – Assuntos Jurídicos é a tabela responsável por gravar os assuntos jurídicos com os campos que definem os Grupos e Pastas no Fluig.
Acesse o módulo do configurador e confira a criação dos campos abaixo:
- NYB_IDGRP – Contêm o ID do grupo criado no Fluig\GED, que controla as permissões do Fluig. Será preenchido pelo Fluig\GED;
- NYB_IDGED – Link que indica onde a pasta foi criada, pode variar de acordo com o Fluig\GED utilizado. Deve seguir o formato <ID_DOCUMENTO>;<VERSAO>. Será preenchido pelo Fluig\GED;
Acesse o módulo do configurador e acesse a rotina de Usuários:
- Cadastre os usuários que utilizam a rotina Processos no Gestão Jurídica (SIGAJURI) e informe os endereços de e-mails;
RM
Não se Aplica.
FLUIG
- Crie no Fluig uma pasta com autorização para todos os usuários;
- Crie os usuários no Fluig informando o mesmo endereço de e-mail cadastrado no Cadastro de Usuários do Microsiga Protheus®;
Controle de Versão
O grupo TOTVS, representado por suas marcas, irá administrar administra as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
Suporte
O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus e Backoffice Microsiga Protheus® estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.
Observação: Este modelo de suporte está sendo revisado pela TOTVS.
Transações/Entidades/Mensagens únicas
Apresente quais as transações/entidades que são trocadas e quem envia a informação para quem. Pode (e recomenda-se) ter um diagrama, uma tabela ou afins que apresente este fluxo.
Relacione quais são as mensagem únicas (TOTVSMessage) utilizadas e qual o seu relacionamento com as entidades já existentes do ERPs envolvidos.
Exemplos:
Método | ID | Descrição | Origem | Destino | XSD (versões podem variar) |
Cadastros | 01 | Cliente/Fornecedor | RM | Protheus | CustomerVendor_1_000.xsd |
02 | Moeda | RM | Protheus | Currency_1_000.xsd | |
03 | Unidade de Medida | RM | Protheus | UnitOfMeasure_1_000.xsd | |
04 | Produto | RM | Protheus | Item_?_000.xsd | |
05 | Centro de Custo | RM | Protheus | CostCenter_1_000.xsd | |
06 | Ativos | RM | Protheus | NOVA, Ativo fixo | |
07 | Funcionários | RM | Protheus | Employee_1_000.xsd | |
08 | Projeto | RM | Protheus | Project_1_000.xsd | |
09 | Obra | RM | Protheus | SubProject_1_000.xsd | |
10 | Tarefa | RM | Protheus | TaskProject_1_000.xsd | |
11 | Meio de Pagamento | RM | Protheus | ?????.xsd | |
12 | Condições de pagamento | RM | Protheus | PaymentCondition_1_000.xsd | |
13 | Coligada* | RM | Protheus | Company_1_000.xsd | |
14 | Filial* | RM | Protheus | Branch_2_000.xsd | |
Processos | 15 | Solicitações (compras/armazém) | Protheus | RM | Request_1_000.xsd |
16 | Cancelar movimento (solicitação, OS, etc) | Protheus | RM | CancelRequest_1_000.xsd | |
17 | Cancelar movimento (solicitação, OS, etc) | RM | Protheus | CancelRequest_1_000.xsd | |
18 | Baixa de estoque | Protheus | RM | Request_1_000.xsd | |
19 | Baixa de estoque | RM | Protheus | Request_1_000.xsd | |
20 | Consulta Saldo | Protheus | RM |
| |
21 | Apropriação de custos |
|
| Request _1_000.xsd | |
22 | Geração de OS |
|
|
| |
23 | Consulta de OS |
|
|
| |
24 | Ampliação patrimonial |
|
|
|
Fluxo das Informações
Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.
Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.
Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.
Cadastros
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
<Transação/Entidade>
Identificador da Mensagem: <mensagem>
Versão: <versão>
Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>
Módulo <marca 2>: <SIGAXXX>
Tipo de Envio: <Assíncrona/Síncrona>
Mensagem Padrão | PROTHEUS | RM | ||
Tabela | Campo | Tabela | Campo | |
Code | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO * |
Description | CTO990 | CTO_DESC | GMOEDA | DESCRICAO |
Symbol | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO |
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca
Limitações/Restrições
Descreva limitações e restrições para a integração que está sendo descrita.
Processos
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
<Transação/Processo>
Tipo de Fluxo: Protheus -> RM
Mensagem: Request_1_000
Versão: 1.000
Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.
Acrescentar um diagrama do processo.
A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
Limitações/Restrições
Descreva limitações e restrições para a integração que está sendo descrita.
Limitações / Restrições Gerais
Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:
- ERP1 envia ITEM cadastrado para o ERP2
ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.
Se o tipo de valorização do estoque for FIFO.
- ERP2 envia PEDIDO cadastrado para o ERP1
O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.
Como fazer (opcional)
Descreva os passos que viabilizem a integração.
Exemplo:
Os passos para viabilizar a integração são:
- No Logix ou no Protheus efetue o cadastro das seguintes informações: Clientes, fornecedores, transportadores, cidades, cotação de moeda e unidades de medida.
- No Logix cadastrar um novo depositante e efetuar toda a parametrização necessária para a operação de WMS.
- No Logix cadastrar um novo produto que seja controlado pelo WMS, para o depositante cadastrado anteriormente.
- No Logix efetuar um processo de recebimento para o produto cadastrado anteriormente, utilizando uma nota fiscal provisória (tipo “A”).
- No Protheus consultar a nota fiscal de recebimento que foi registrada no Logix, validando as informações recebidas.
- No Logix efetuar um processamento de regularização fiscal, efetuando a cobertura dos produtos recebidos anteriormente.
- No Protheus verificar se foi efetuado corretamente o relacionamento entre os dois documentos.
- No Logix efetuar um processo de expedição para o novo produto cadastrado, até o momento do envio da mensagem de integração de pedido de venda.
- No Protheus efetuar o faturamento do pedido de venda recebido.
- No Protheus verificar se a nota fiscal gerada contém todas as informações necessárias para o segmento de operador logístico (armazém geral).
- No Protheus efetuar a escrituração fiscal das notas fiscais, verificando se as regras da legislação deste segmento foram respeitadas.
- No Logix é possível consultar o número do pedido de venda gerado para as notas fiscais de retorno simbólico e conta/ordem no programa WMS6333 (Consulta de Documentos). Para os processos de faturamento de serviço o número do pedido está disponível no programa WMS6411 (Movimentos a Faturar).
Situações comuns (opcional)
Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.
Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.
Exemplo 1:
Tratamento de erros de integração (Produto A)
Erro | Mensagem | Solução |
Código do erro | Mensagem exibida | Ação a ser tomada para resolução do erro. |
Tratamento de erros de integração (Produto B)
Erro | Mensagem | Solução |
Código do erro | Mensagem exibida | Ação a ser tomada para resolução do erro. |
Exemplo 2:
Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:
Exemplo:
Erro ao enviar a mensagem de Cidade via Integração
Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:
-------------------------------------------------------------------------------
WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw
ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51
-------------------------------------------------------------------------------
Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService.
Checklist de suporte da aplicação
Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.
Instalação/Configuração
Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.
Checklist de Verificações:
Relacione itens de verificações para que o atendente possa:
- Identificar o funcionamento da integração;
- Identificar a ocorrências de problemas;
- Coletar evidências do mau funcionamento relatado pelo cliente;
- Realizar possíveis ajustes na integração quanto à configuração ou negócio.
Anexos
...
Abaixo, segue uma lista dos serviços do Fluig que devem ser consumidos pelo Microsiga Protheus® para que a integração seja realizada :
Operação | Serviço | Função |
Criação de pastas | ECMFolderService | createSimpleFolder |
Atualização de pastas | ECMFolderService | updateFolder |
Informações das pastas | ECMFolderService | getFolder |
Segurança da pasta | ECMFolderService | getSecurity |
Permissões de usuários | ECMFolderService | getUserPermissions |
Atualização de título da pasta | ECMFolderService | updateSimpleFolder |
Obter o Colleague ID do usuário, que é usado em quase todas as operações. | ECMColleagueService | getColleaguesMail |
Criar grupos | ECMGroupService | createGroup |
Apagar um grupo | ECMGroupService | deleteGroup |
Associa um usuário a um grupo. | ECMColleagueGroupService | createColleagueGroup |
Exclui um usuário de um grupo. | ECMColleagueGroupService | deleteColleagueGroup |
Retorna somente um grupo que determinado usuário participa. | ECMColleagueGroupService | getColleagueGroup |
Retorna os grupos que um usuário participa. | ECMColleagueGroupService | getColleagueGroupsByColleagueId |
Retorna os usuários que participam de um grupo de usuários. | ECMColleagueGroupService | getColleagueGroupsByGroupId |
Fonte: dev.fluig.com (http://tdn.totvs.com/pages/viewpage.action?pageId=73084007)
As entidades e os pontos de integração que fazem parte desta integração são:
Método | ID | Descrição | Origem | Destino | Ponto de Integração |
Processos | 01 | Documentos | Fluig | Microsiga Protheus® | Upload / Dowload / Controle de documento. |
02 | Casos | Microsiga Protheus® | Fluig | Criação / Alteração de um Caso. Inclui registro do Caso na Tabela NZ7 – Casos GED | |
03 | Processos | Microsiga Protheus® | Fluig | Criação / Alteração de um processo. Inclui uma Pasta para o caso no Fluig observando o assunto jurídico. | |
04 | Configuração de Pesquisas | Microsiga Protheus® | Fluig | Relacionamento de Usuário a pesquisa. Alteração do Grupo ou a Segurança da Pasta dependendo do usuário. | |
05 | Anexos | Microsiga Protheus® | Fluig | Vinculo de Documento no Fluig com Processos, Andamentos, Folow Ups e Garantias. Atalho para pasta do caso e abertura de documentos. |
Fluxo das Informações
O fluxo de informação segue conforme o diagrama abaixo:
PROTHEUS | FLUIG |
---|
Não se Aplica.
Processos
Não se Aplica.
Limitações / Restrições Gerais
Não se Aplica.
Checklist de suporte da aplicação
No Microsiga Protheus®, pelo modulo Configurador (SIGACFG) verifique a criação e configuração dos itens abaixo:
- Criação da tabela NZ7 – Casos GED;
- Criação dos campos na tabela NYB – Assuntos Jurídicos;
- Confira ou atualize pelo configurador o parâmetro MV_JDOCUME configurado com a opção 3 que significa Fluig;
- Confira ou atualize pelo configurador o parâmetro MV_JDOCPAI configurado com o número da pasta raiz do Fluig;
- Confira ou atualize pelo configurador o parâmetro MV_JFLSUBP configurado com os nomes de pastas que devem ser criadas depois da pasta do Caso;
- Confira ou atualize pelo configurador o parâmetro MV_ECMURL configurado com o nome ou IP do servidor Fluig; Parâmetro MV_ECMURL deve conter a palavra webdesk entre "/" (barras). Exemplo: http//:127.0.01:8080/webdesk/
- Confira ou atualize pelo configurador o parâmetro MV_ ECMUSER configurado com o usuário administrador do servidor Fluig;
- Confira ou atualize pelo configurador o parâmetro MV_ ECMPWD configurado com a senha do administrador do servidor Fluig;