Histórico da Página
INTEGRAÇÃO BACKOFFICE RM X PORTAL DE COMPRAS PARADIGMA - WBC
Contexto de negócio (Introdução)
A integração do ERP TOTVS RM com o Portal de Compras Paradigma (WBC - Web Business Center) permite que o usuário integre os pedidos de compra originados ou não de cotação no TOTVS Gestão de Estoque, Compras e Faturamento para o Portal de Compras Paradigma (WBC – Web Business Center). Essa integração permite que seja realizado todo o processo de cotação da compra, comunicação aos fornecedores, requisição e aceite do pedido pelo fornecedores.
Sistemas Envolvidos
- ERP RM, módulo Gestão de Estoque, Compras e Faturamento;
- Portal de Compras Paradigma - WBC.
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.
dinâmica da economia e o acirramento da competitividade num mundo que se comunica cada vez mais rápido e intensamente, obriga as empresas a buscarem novos meios e tecnologias para otimizar seus processos de gestão.
O setor de suprimento administra considerável percentual do orçamento das empresas, muitas vezes maior que o faturamento gerado em diferentes unidades de negócio. Por isso, passa a ser estratégico reduzir o tempo e o custo operacional dos processos de compras e o valor final de aquisição.
Reduzir os gastos com compras, seja no custo direto das aquisições ou nas despesas operacionais do processo, pode representar um aumento significativo na lucratividade de qualquer organização. Outra vantagem é a agilidade e abrangência simultânea oferecida pelos meios eletrônicos, permitindo menor investimentos em estoques, pela maior agilidade nos ciclos de reposição, com mais opções acessíveis de abastecimento.
Considerando o contexto apresentado, vislumbrou-se a oportunidade de oferecer aos usuários a integração de seu sistema integrado de gestão empresarial (ERP onde são controladas as aquisições, vendas e estoque) com portal de e-procurement, que oferece um conjunto de modalidades de negociação, ferramentas complementares, acesso na nuvem para contato com maior número de fornecedores para a negociação e módulo administrativo que permite a gestão de cadastros.
Sistemas Envolvidos
Descrição dos sistemas envolvidos no contexto de negócio.
- Portal de Compras Paradigma – Solução eletrônica de compras disponível em nuvem (pública ou privada) que visa disponibilizar funcionalidades voltadas para supply chain, com um conjunto de modalidades de negociação e ambiente voltado a grande sinergia entre os stakeholders.
- BackOffice RM - Sistema integrado de gestão empresarial (ERP) que disponibiliza através do módulo de Gestão de Estoque, Compras e Faturamento todo o processo de cotação e compras a ser integrado ao Portal Paradigma.
Integração
A comunicação do BackOffice RM com o Portal de Compras Paradigma será efetuada através da invocação de procedimentos remotos (WebServices), sem a intervenção de nenhum EAI (como feito na integração Datasul x Paradigma), tanto para envio de informações ao Portal quanto para consultas. A comunicação é inciada a partir do BackOffice RM que utiliza os WebServices do Portal de Compras Paradigma para envio de informações e consulta de dados, nunca no sentido contrário. Os adapters de comunicação com WebServices Paradigma serão desenvolvidos com base no uso de assinantes (Subscribers).
Visto que o Paradigma trabalha de forma passiva, sem consumir nenhum serviço para envio, será necessário agendar os processos que obtém retorno de informações (retorno de cotação, aceite de pedido e outros) via Jobserver com a recorrência necessária para a operação de cada cliente.
É aconselhável que seja verificado também a necessidade de agendar de forma recorrente (diária) os processos de carga inicial de cadastros, selecionando a opção de envio somente de registros desatualizados, para garantir a consistência dos dados entre os dois sistemas.
Os tipos de comunicação podem ser divididos em quatro tipos, listados abaixo:
1. Carga de dados
Processo disponível para envio de dados massivos para o Portal, disponibilizando carga total, carga parcial e carga de registros selecionados, consumindo os respectivos WebServices. Para cada cadastro integrado com o Portal de Compras Paradigma será disponibilizado um processo para carga de dados, que apresentará três opções de integração, sendo elas:
· Carga total – Faz a sincronização de todos os registros.
· Carga parcial – Faz a sincronização dos registros ainda não integrados ou desatualizados.
· Somente selecionados – Faz a sincronização dos registros selecionados no processo.
2. Comunicação síncrona (gatilho automático)
Comunicação síncrona com gatilho a partir das funções nativas do sistema (gatilhos nos assinantes ou por Fórmulas Visuais), sem necessidade do usuário executar um processo manual para disparar a integração.
3 – Comunicação assíncrona - Saída (gatilho manual)
A comunicação deve ser iniciada através do consumo de processo ou funcionalidade por parte do usuário. Serão disponibilizados processos nas visões, onde o usuário responsável deverá selecionar os registros desejados e disparar os mesmos.
4 – Comunicação assíncrona - Entrada (processo recorrente)
1. Carga de dados
Processo disponível para envio de dados massivos para o Portal, disponibilizando carga total, carga parcial e carga de registros selecionados, consumindo os respectivos WebServices.
2. Comunicação síncrona (gatilho automático)
Comunicação síncrona com gatilho a partir das funções nativas do sistema (gatilhos nos assinantes ou por Fórmulas Visuais), sem necessidade do usuário executar um processo manual para disparar a integração.
3 – Comunicação assíncrona - Saída (gatilho manual)
A comunicação deve ser iniciada através do consumo de processo ou funcionalidade por parte do usuário.
4 – Comunicação assíncrona - Entrada (processo recorrente)
A extração de dados no Portal de Compras Paradigma ocorre através de consultas aos WebServices do mesmo. Para tanto, é necessário que seja programado de forma recorrente a execução dos processos de extração no JobServer, que ficarão responsáveis por dar entrada nos dados.
Escopo
A integração do BackOffice RM com Portal de Compras Paradigma visa disponibilizar aos usuários que seus processos de cotação e pedidos de compra sejam integrados com seus fornecedores através de ambiente em nuvem, trazendo maior economia no processo de compras e sinergia entre os stakeholders.
O processo de integração de cotações permite que as cotações iniciadas no BackOffice RM possam ser enviadas ao Portal de Compras Paradigma e passar por reagrupamento (aglutinação) e cotação online, com recebimento de orçamentos, seleção de orçamento vencedor e retorno automatizado das informações ao BackOffice.
Juntamente com o processo de integração de cotações, foi disponibilizada a integração de Pedidos de Compra (oriundos de Cotações integradas ou não) que é responsável por encaminhar ao fornecedor as informações do Pedido e solicitar aprovação do mesmo, que posteriormente seguirá o fluxo de compras no BackOffice definido pelo cliente.
Segue listado abaixo os processos de integração disponíveis para que as funcionalidades listadas acima sejam disponibilizadas:
- Envio de Cadastros.
- Especificação completa disponível em
· Envio de Itens de Requisição.
o Especificação completa disponível em http://tdn.totvs.com/display/public/rm/CMP_BT_RequisicaoParadigma_BRA_PCREQ-4533
· Consulta cancelamento de Itens de Requisição.
o Especificação completa disponível em http://tdn.totvs.com/display/public/rm/CMP_BT_Paradigma+-+Cancelamento_BRA_PCREQ-4527
· Envia cancelamento de Itens de Requisição.
o Especificação completa disponível em http://tdn.totvs.com/display/public/rm/CMP_BT_Paradigma+-+Cancelamento_BRA_PCREQ-4527
· Consulta de Orçamentos de Cotação finalizada.
o Especificação completa disponível em http://tdn.totvs.com/display/public/rm/CMP_BT_RetornoCotacao_BRA_PCREQ-4537
· Envio de Pedidos de Compra.
o Especificação completa disponível em http://tdn.totvs.com/display/public/rm/CMP_BT_Paradigma+-+Pedido+de+Compras_BRA_PCREQ-4539
· Envia cancelamento de Pedidos de Compra.
o Especificação completa disponível em http://tdn.totvs.com/display/public/rm/CMP_BT_Paradigma+-+Cancelamento_BRA_PCREQ-4527
· Consulta de aceite de Fornecedor para Pedido de Compra.
o Especificação completa disponível em http://tdn.totvs.com/display/public/rm/CMP_BT_Paradigma_Aceite_Fornecedor_BRA_PCREQ-4534
O escopo da integração se restringe aos processos e subprocessos descritos nos documentos de especificação listados acima, considerando as regras e restrições descritas internamente a estes.
Pré-requisitos instalação/implantação/utilização
Contrato realizado com a Paradigma para utilização do portal de compras (WBC – Web Business Center).
TOTVS RM instalados, configurados e ativos para a integração com o portal da Paradigma.
Nota: TOTVS RM versão 12.1.5 ou superior
Instalação/Atualização
No módulo Gestão de Estoque, Compras e Faturamento, acessar o menu Ambiente >> Parâmetros >> Gestão de Estoque, Compras e Faturamento e realizar as seguintes configurações:
- Definir o Tipo de Produto fornecido pelo Forncedor: Parâmetros Gerais >> Tabelas >> Classificação.
- Habiltar a integração com o portal Paradigma, definindo a Url do Servidor Paradigma e a Fórmula do Código do Forncedor: Integrações >> Paradigma/Clicbusiness.
- Importar as Fórmulas Visuais: para os cadastros de Coligada, Filial, Moeda, Centros de Custo, Departamento, Fornecedor e Usuário será necessário importar as fórmulas visuais que encontram-se disponíveis na pasta “Sugeridos”, interna à pasta “_ImpExp” no ambiente instalado do sistema (“../CorporeRM/_ImpExp/Sugeridos”). Ao importar as fórmulas visuais deverá ser marcado para cada fórmula o parâmetro Importar Gatilho na rotina de Importação de Fórmula Visual.
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 e Paradigma 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.
Pré-requisitos instalação/implantação/utilização
Contrato realizado com a Paradigma para utilização do portal de compras (WBC – Web Business Center).
TOTVS RM instalados, configurados e ativos para a integração com o portal da Paradigma.
Nota: TOTVS RM versão 12.1.5 ou superior
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.
Paradigma
Insira aqui as informações pertinentes a Datasul.
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
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.