Histórico da Página
Integração de Leads e Oportunidades do RD Station Marketing para o TOTVS CRM
Contexto
A integração entre o RD Station Marketing e o TOTVS CRM por meio do iPaaS foi desenvolvida para otimizar o fluxo de informações entre essas duas plataformas. Com a integração iPaaS, você pode automatizar o processo de envio dos leads gerados no RD Station Marketing para o TOTVS CRM. Isso significa que os dados dos potenciais clientes são enviados automaticamente, sem a necessidade de intervenção manual, o que reduz significativamente o tempo gasto nessa tarefa e elimina erros que poderiam ocorrer durante o processo.
Sistemas Envolvidos
- RD Station Marketing
- iPaaS
- TOTVS CRM
O que esta integração faz?
A integração ocorre por meio de uma configuração de automação, que permite o envio automático e contínuo de leads capturados no RD Station Marketing para o TOTVS CRM. Em outras palavras, os dados dos potenciais clientes gerados por meio das ações de marketing no RD Station são enviados diretamente para TOTVS CRM. Esta funcionalidade de automação está disponível no RD Station Marketing a partir do plano de assinatura PRO.
O que esta integração não faz?
A integração é dedicada apenas as APIs que fazem parte do produto RD Station Marketing. Entidades de outros produtos da RD, como a empresa, que faz parte do produto RD CRM não fazem parte do escopo desta integração.
Em quais momentos específicos ocorre a integração entre o RD Station Marketing e o TOTVS CRM?
No pacote de integração entre a RD Station Marketing e o TOTVS CRM, existem quatro momentos específicos de envio de dados entre as plataformas via evento de Webhook. Esses momentos são:
- Envio de cadastro de leads para o TOTVS CRM: A integração se inicia por meio do fluxo de automação estabelecido no RD Station Marketing, que possibilita o envio dos dados cadastrais do lead diretamente para o TOTVS CRM.
- Marcação de leads como oportunidades no RD Station Marketing: Quando uma oportunidade de negócio é criada no TOTVS CRM e a pipeline for igual a SQL, a RD Station é acionada para marcar o registro do lead correspondente como uma "Oportunidade". Essa integração é fundamental para acompanhar e identificar as oportunidades de negócio dentro do RD Station, simplificando a gestão e acompanhamento dos leads.
- Atualização de oportunidades ganhas no RD Station Marketing: Quando uma oportunidade é atualizada como "Ganha" no TOTVS CRM, a RD Station recebe uma notificação e atualiza o registro do lead correspondente. Isso permite mostrar no RD Station que a negociação foi realizada com sucesso, além de possibilitar incluir o valor da venda. Com essas informações, é possível ter uma visão clara das conquistas e dos resultados financeiros alcançados
- Atualização de oportunidades perdidas no RD Station Marketing: Da mesma forma, quando uma oportunidade é atualizada como "Perdida" no TOTVS CRM, a RD Station é informada e atualiza o registro do lead correspondente. Essa sincronização é muito importante, pois indica que a oportunidade não foi concretizada, permitindo que o motivo da perda seja registrado na RD Station.
- Responsável do lead atualizado no TOTVS CRM: quando um responsável é modificado no TOTVS CRM a integração realiza a atualização na RD Station, caso o responsável não exista na RD a atualização não é feita.
Observação: É importante destacar que a RD Station aceita valores de oportunidades ganhas com um limite de R$ 99.999.999,00. Valores acima desse limite serão rejeitados pela API padrão da plataforma.
Diagrama da integração de Leads com origem no RD Station Marketing para o TOTVS CRM
Diagrama da integração TOTVS CRM → RD Station Marketing
Escopo
Quais campos podem ser integrados entre RD Station Marketing e o TOTVS CRM?
É possível integrar uma variedade de campos, dependendo das configurações específicas realizadas durante o processo de integração. Entre as possibilidades do modelo padrão, incluem-se:
- Cidade (limite de 255 caracteres)
- Celular (limite de 255 caracteres)
- Cargo (limite de 255 caracteres)
- E-mail - (limite de 255 caracteres)
- Estado - (limite de 255 caracteres)
- Facebook - (limite de 255 caracteres)
- Linkedin - (limite de 255 caracteres)
- Nome - (limite de 255 caracteres)
- Telefone - (limite de 255 caracteres)
- Website - (limite de 255 caracteres)
Além dos campos mencionados anteriormente, é importante destacar que o cadastro padrão também inclui variáveis que são preenchidas automaticamente. Essas variáveis incluem:
- Situação do Lead: Ativo
- Tipo de lead: Lead
- Origem do Lead: RD Station
- Tipo de e-mail: Principal
- Tipo de telefone: Principal
- Tipo de endereço principal
- Usuário padrão caso não tenha responsável
- Etapa
- Tipo de Oportunidade
- Pipeline
Observação: É importante ressaltar que os campos específicos podem variar conforme as configurações de entrada de dados, como Landing Pages e formulários, durante o processo de integração.
Pré-requisitos Cliente
É necessário contratar o pacote Pro ou Advanced da RD Station, pois o recurso de automação avançada é necessário para a integração.
Pré-requisitos RD Station Marketing
A exportação de LEADS deve ser configurada com um Webhook, seguem os passos de como pegar este endereço:
A URL do Webhook iPaaS será disponibilizada durante a configuração inicial da integração. Esse processo ocorre por meio de etapas de “wizard”, ou seja, os passos sequenciais para concluir a configuração. Se você enfrentar qualquer dificuldade durante essa etapa, recomendamos entrar em contato com o suporte do produto iPaaS para receber orientações e assistência.
Para obter a URL do iPaaS, siga estas etapas:
- Acesse https://ipaas.totvs.app/ em seu navegador;
- No menu "Integrações", clique em "Projetos & Pacotes";
- No campo de busca, digite "Rd Station x CRM" e pesquise;
- No card "Lead RD Station to TOTVS CRM", clique em "Editar";
- No diagrama da integração, clique no ícone de engrenagem ao lado de "Webhook" e copie a URL fornecida;
- Segue imagem de exemplo:
Para configurar o Webhook e criar o fluxo de integração no RD Station, siga as etapas abaixo:
- No menu, acesse a opção "Relacionar";
- Clique em "Automação de Marketing" conforme imagem:
- Em seguida, clique em "Criar Fluxo";
- Nomeie o fluxo e clique em "Continuar";
- No card de entrada, selecione uma opção para definir quais leads farão parte do fluxo de integração: "Novos leads" (somente os novos leads que atenderem às condições após a ativação) ou "Todos os leads" (todos os leads que já atendem às condições);
- Na lista de opções de entrada, escolha uma das seguintes: "Convertidos em evento", "Entraram na lista de segmentação", "Foram marcados como oportunidade" ou "Campo do lead";
- Após definir a opção de entrada, clique no ícone "+" ao lado do card de entrada e localize a ação "Enviar Leads para integração";
- Arraste o card "Enviar leads para integração" até o ícone "+" e inclua a URL do iPaaS;
- Por fim, salve e ative o fluxo;
- O iPaaS receberá as mensagens com os dados dos leads por meio do Webhook e realizará os tratamentos necessários para atender aos requisitos da API padrão do TOTVS CRM.
Aqui está um exemplo de um fluxo simples criado:
Observação: É importante lembrar que cada integração do cliente terá um “integrationId” único, proporcionando a individualidade necessária e garantindo a segurança dos dados entre as plataformas.
Para mais detalhes sobre o processo de configuração no RD Station e as regras de exportação de leads para o Webhook da integração, consulte o seguinte link:
Pré-requisitos iPaaS:
É necessário realizar a configuração das variáveis específicas para esse pacote de integração. As variáveis e seus valores são os seguintes:
- Abra o seu navegador e acesse o site https://ipaas.totvs.app/
- No menu do site, procure pela opção "Integrações" e clique nela.
- Em seguida, procure pelo submenu "Variáveis" e selecione essa opção.
- Na página de cadastro de variáveis, localize a opção "Cadastrar variável" e clique nela.
- Agora, você será solicitado a preencher os campos "Chave" e "Valor" para cada variável.
Variável | Valor | Descrição |
totvs_crm_leadsituation_id | 1aa8633e-5ff3-4bc4-a7d5-1b63a879c4f2 | ID situação LEAD equivalente a ATIVO |
totvs_crm_leadorigin_id | ac80e699-8a31-4f20-9833-d1d3656ee89d | ID origem equivalente a RD Station |
totvs_crm_emailtype_id | 7391c70e-aeb8-4c68-bd5c-7b5d30cf4d1d | ID tipo de e-mail. |
totvs_crm_phonetype_main_id | d870427c-bbad-4eb8-9af5-5183b47f648f | ID tipo de telefone PRINCIPAL |
totvs_crm_phonetype_mobile_id | 67cd545a-cf05-441e-a0ec-635c44e60d41 | ID tipo de telefone MÓVEL |
totvs_crm_addresstype_id | b604f287-36bf-4e6d-ae83-c75c46a2fbeb | ID Tipo de endereço equivalente ao PRINCIPAL |
totvs_crm_oportunity_stage | Abordagem e Investigação | Descrição da etapa (stage) |
totvs_crm_oportunity_type | Integração RD Station | Descrição do tipo de oportunidade |
totvs_crm_pipeline | MQL - Marketing Qualified Lead | Descrição da pipeline |
totvs_crm_default_user | A critério do cliente | Informar um e-mail existe no CRM para caso não seja encontrado o usuário responsável. OBS: este usuário deverá possuir um papel cadastrado, do contrário não será possível inserir o Lead |
totvs_crm_customerpersontype_pf_id | 8cea3c86-1984-4c77-acf5-3f622c1efe5b | ID tipo de pessoa Física |
totvs_crm_customerpersontype_pj_id | 40694c1a-44f9-4c3b-a5a8-aa63e0742c75 | ID tipo de pessoa Jurídica |
totvs_crm_pipeline_sql_id | 46b0f7c0-01de-473b-b767-591a67eec35c | ID da pipeline SQL no TOTVS CRM |
totvs_crm_expecteddays | 7 | Prazo de conclusão da oportunidade, considere data atual + totvs_crm_expecteddays |
raizoportunidade | Link padrão de oportunidades do TOTVS CRM |
Observação: É importante salientar que os valores de ID fornecidos acima são exemplos baseados na configuração padrão do TOTVS CRM. Durante a implementação da integração, é fundamental revisar e ajustar os valores de ID de acordo com o tenant do cliente. Isso garante que a integração seja realizada corretamente.
O próximo passo é configurar o acesso do aplicativo da RD Station dentro do iPaaS:
- Acesse o iPaaS;
- Vá em Aplicativos > RD Station > Ambientes;
- Crie um ambiente customizado (CASO NÃO EXISTA) com a URL https://api.rd.services e com os tipos de autenticação API KEY e OAUTH2 CODE;
- Vá na aba Contas e crie uma adicionando os dados obtidos na documentação da RD Station: https://developers.rdstation.com/reference/autenticacao-video
- Segue abaixo um exemplo com as informações já preenchidas:
- Depois de configurado é só testar se a conta está ativa:
Pré-requisitos TOTVS CRM:
Lembre-se de que as variáveis cadastradas no iPaaS existam no TOTVS CRM.
Para garantir a atualização adequada do registro no RD Station sempre que uma oportunidade for criada no TOTVS CRM, ganha ou perdida, é essencial configurar corretamente no workflow. Isso envolve a definição de um gatilho no TOTVS CRM que será responsável por enviar os dados da oportunidade para a URL de Webhook do iPaaS, responsável pela atualização no RD Station.
Abaixo estão os gatilhos necessários a serem criados no TOTVS CRM para funcionar corretamente a integração:
Nome | Gatilho | Ação | Filtros | URL |
RD - Oportunidade perdida | Oportunidade perdida | Chamar um endpoint HTTP remoto | Tipo de oportunidade igual a Integração RD Station | URL do serviço do iPaaS Opportunity CRM To RD Station |
RD - Oportunidade ganha | Oportunidade ganha | Chamar um endpoint HTTP remoto | Tipo de oportunidade igual a Integração RD Station | URL do serviço do iPaaS Opportunity CRM To RD Station |
RD - Oportunidade atualizada | Oportunidade atualizada | Chamar um endpoint HTTP remoto | Tipo de oportunidade igual a Integração RD Station | URL do serviço do iPaaS Opportunity CRM To RD Station |
RD - Atualiza Responsável do Lead | Lead atualizado | Chamar um endpoint HTTP remoto | Origem igual a RD Station | URL do serviço do iPaaS Change Lead Owner CRM to RD Station |
RD - Atualiza Responsável do Cliente | Cliente atualizado | Chamar um endpoint HTTP remoto | Origem igual a RD Station | URL do serviço do iPaaS Change Lead Owner CRM to RD Station |
Observação: Após realizadas essas ações, toda vez que uma oportunidade for ganha, atualizada ou perdida, os workflows dispararão a informação para o RD Sation.
Exemplo do fluxo
Desde a criação no RD até ganhar a oportunidade no TOTVS CRM e ser atualizado novamente no RD Station:
FAQ
Como a integração efetua a validação se o lead já existe?
O iPaaS da TOTVS desempenha um papel fundamental na integração entre o RD Station Marketing e o TOTVS CRM. Ele é responsável por validar o ID do RD Station associado a um LEAD e ao endereço de e-mail correspondente, além de armazenar essas informações no CRM.
A funcionalidade do iPaaS inclui um mecanismo de verificação para evitar a duplicação de registros no CRM. Quando um LEAD já está presente no CRM, o iPaaS cria apenas a oportunidade, evitando a duplicidade.
É importante mencionar que essa solução foi projetada com base na arquitetura existente, sem a utilização da integração HUB para o processamento de dados. Embora a integração atual seja mais simples e restrita, seu foco principal é garantir a transferência eficiente do LEAD do RD Station para o TOTVS CRM, além de manter a sincronização adequada entre as oportunidades geradas no CRM e as atualizações correspondentes no RD Station.
À medida que o projeto evolui e as versões futuras são consideradas, é necessário realizar uma nova avaliação pelos times de produto. Essa avaliação determinará se é necessário expandir o escopo da integração, possivelmente incorporando a utilização da integração HUB para atender a requisitos mais complexos e abrangentes.
É possível customizar a integração para atender às necessidades específicas de um negócio?
Sim, é possível contemplar campos customizados de interesse do cliente, porém, será necessária uma contratação adicional do serviço. A inclusão desses campos personalizados exigirá uma modificação no diagrama/pipeline do iPaaS fornecido ao cliente específico.
É importante destacar que o modelo atual do iPaaS utiliza apenas os campos padrão disponibilizados pela API do TOTVS CRM. Portanto, qualquer adição de campos personalizados requer uma alteração no iPaaS, que será realizada através do atendimento da área de serviços.
Dessa forma, o cliente terá a oportunidade de personalizar a integração de acordo com suas necessidades específicas, incluindo campos customizados de interesse. O processo de alteração será coordenado pela equipe de serviços, garantindo a correta adaptação do TOTVS CRM e o bom funcionamento da integração com o RD STATION.
INTEGRAÇÃO <NOME DO REQUISITO> X <VERTICAL/MÓDULO YYY>
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).
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.