Páginas filhas
  • DI_SIGATMS_x_Datasul_Contas_a_Receber

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

INTEGRAÇÃO

<NOME DO REQUISITO> X <VERTICAL/MÓDULO YYY>

PROTHEUS SIGATMS X DATASUL BACKOFFICE

Contexto de negócio (Introdução)

Contextualização sobre do que se trata a área em que iremos dissertar tal integração.

 

Seu negócio, sua gestão, complexidade, o que está envolvido (em demais áreas), processos, etc. Tais explanações não precisam citar ferramentas (softwares) e sim as expectativas e resultados do uso de um sistema informatizado.

 

Interessante citar as tendências e necessidades de mercado, o quê, em geral, os software proporcionam (destinam/propósito), principais recursos, etc, e motivos que levaram a criar a integração (em outros termos, o porquê de integrar).

 

O módulo SIGATMS da linha Microsiga Protheus possui integração nativa com os módulos de BackOffice de mesma linha como, faturamento (SIGAFAT), fiscal (SIGAFIS), financeiro (SIGAFIN) e contábil (SIGACTB).

Existem clientes da linha Datasul que demandam a necessidade de utilização de um módulo de Gestão de Transportes como o SIGATMS, porém mantendo os módulos de BackOffice da linha Datasul.

Para que seja possível atender esta demanda e possibilitar uma nova oferta de mercado TOTVS, através desta integração será possível a utilização do módulo SIGATMS da linha Microsiga Protheus integrado aos módulos de BackOffice da linha Datasul (faturamento, fiscal, financeiro e contábil).

 

Sistemas Envolvidos

Linha Microsiga Protheus

  • SIGATMS (Transportation Management System): sistema de gerenciamento de transportes que tem como objetivo principal controlar todos os processos fiscais e gerenciais envolvidos na operação de transportes, bem como, controlar os veículos, motoristas, fretes e viagens da empresa e de terceiros, entre as atividades mais importantes destacam-se controle das despesas dos veículos, viagens, fretes, emissão de CTRC (Conhecimento de Transporte Rodoviário de Cargas), nota fiscal de serviço, manifesto e outros. O SIGATMS controla todos os processos de um transportador, abrangendo as áreas: operacional, comercial, seguros, faturamento, logística e SAC. Solução totalmente integrada com a área administrativa (financeiro, fiscal e contábil).

Linha Datasul (BackOffice)

  • Faturamento:
  • Fiscal:
  • Financeiro:
    • ACR (Contas a Receber): 
    • APB (Contas a Pagar): 
  • Contábil:

 

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

  • Sistema/Módulo vertical - Qual o módulo, qual marca, suas principais características, funcionalidades, escopo do módulo, etc
  • BackOffice(s) - Qual(ais) marca(s), o que o ERP engloba, quais são seus pontos fortes, funcionalidades, etc, explanações principalmente no que diz respeito às funcionalidades do ERP que serão utilizadas pela integração (mas sem citar a integração)

    Integração

    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

    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.

    Controle de Versão

    O grupo TOTVS, representado por suas marcas, irá administrar 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 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*
    * implementado, mas o Protheus não vai enviar, estamos avaliando alternativa para preencher o de/para

    RM

    Protheus

    Company_1_000.xsd

    14

    Filial*
    * implementado, mas o Protheus não vai enviar, estamos avaliando alternativa para preencher o de/para

    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