INTEGRAÇÃO BackOffice Datasul x Ciashop

A integração entre o BackOffice Datasul e a Plataforma e-Commerce da Ciashop tem como objetivo realizar a comunicação da loja de comércio eletrônico com o ERP Datasul.

Sistemas Envolvidos

Linha Ciashop

• Ciashop: Sistema vertical desenvolvido pela CiashppCiashop, empresa do ecossistema TOTVS, que dispõe de módulos e aplicativos voltados para o e-commerce. Com a plataforma Framework Ciashop é possível montar sua própria loja de comércio eletrônico, integrando esta loja, com os principais marketplaces disponíveis no mercado.

Linha Datasul (BackOffice)

• ERP Datasul: Sistema de BackOffice para gestão de empresas com ênfase no segmento de Manufatura. Disponibiliza módulos de gestão e controle da distribuição com foco nos requisitos comerciais, fiscais e tributários, entre eles: Pedidos de Venda, Faturamento e Embarques.

Integração

A forma de comunicação entre ERP e Ciashop se dará por meio de mensagens enviadas e recebidas de um Web service RESTfull. Os Web services RESTful são serviços construídos com o estilo de arquitetura RESTful. A construção de Web services com a abordagem RESTful está surgindo como uma alternativa popular ao uso de tecnologias baseadas em SOAP para implantação de serviços na Internet, por ser mais leve e ter a capacidade de transmitir dados diretamente via HTTP.

Escopo

A plataforma Framework Ciashop é uma plataforma em que o cliente pode montar sua própria loja de comércio eletrônico.

O Ciashop permite que o cliente monte sua própria loja virtual. Para estabelecer a estrutura da loja virtual com seus departamentos e itens postos a venda o ERP deverá fornecer tais informações. A loja virtual estará integrada com o ERP transmitindo para este os clientes e pedidos cadastrados na loja virtual.

A forma de comunicação entre ERP e Ciashop se dará por meio de mensagens enviadas e recebidas de um Web service RESTfull. Os Web services RESTful são serviços construídos com o estilo de arquitetura RESTful. A construção de Web services com a abordagem RESTful está surgindo como uma alternativa popular ao uso de tecnologias baseadas em SOAP para implantação de serviços na Internet, por ser mais leve e ter a capacidade de transmitir dados diretamente via HTTP.

O conceito de Marketplace (MP), no comércio eletrônico, é a utilização de uma loja virtual de terceiros para vender os seus produtos.Sales Hub é um aplicativo disponível para Lojas Framework da Ciashop que concentra diversos marketplaces, tais como Extra e Walmart. Através deste aplicativo é possível ofertar os produtos da loja nestes marketplaces e gerenciar os pedidos gerados nestes canais em sua própria loja.

O objetivo da integração é possibilitar a integração dos Cadastros de Famílias Comerciais, Itens, Tabela de Preço e Saldo em Estoque disponível do Datasul para o Ciashop. Assim como, a integração do recebimento de pedidos de venda oriundos do Ciashop e a atualização do status destes pedidos.

Pré-requisitos instalação/implantação/utilização

Datasul

Versão\release 12.1.17

Parâmetros de integração ativo: Cadastros Gerais -> Cadastros Gerais -> Cadastros -> Funçâo: Manutenção Cadastros Gerais Parâmetro Global (CD0101 - Aba Integr II)

Parâmetros de configuração da integração ativo: Menu -> Logística -> Pedidos -> Cadastros -> Função: Parâmetros Integração Ciashop

Instalação/Atualização

 Vide tópico Pré-requisitos instalação/implantação/utilização.

Datasul

 Vide tópico Pré-requisitos instalação/implantação/utilização.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução das mensagens de integração 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 Ciashop e Backoffice Datasul 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

Fluxo das Informações

 Os cadastros devem ser realizados no Datasul e integrados para o Ciashop, a ativação da integração, no entanto, não impede a inclusão, alteração e exclusão de registros no Ciashop, mas esse procedimento não é recomendado, pois as operações realizadas sobre os cadastros no Ciashop, não são replicadas para os respectivos cadastros no Datasul.

Para realizar uma operação de inclusão ou alteração, é necessário que seja disparado o programa de carga/atualização no Datasul, para que estes dados sejam considerados na integração e a atualização seja efetuada no Ciashop. A operação de eliminação sobre os registros de cadastros não é integrada, pois não é possível verificar a integridade referencial no sistema de destino para considerá-la como restrição de eliminação dos registros no Datasul.

O sucesso das operações de inclusão e alteração de registros pode ser verificado acessando o programa Monitor Integração Ciashop (PD0625). Por meio deste programa, é possível realizar a consulta do envio dos registros referente aos cadastros de Família Comercial, Itens, Preço Item,Saldo em Estoque, recepção dos pedidos e atualização dos status dos pedidos.

Através do programa Integração Batch Ciashop (PD0624) é possível realizar a carga/atualização dos registros em lote, ele pode ser acessado pelo menu do Datasul em: Logistica -> Pedidos -> Tarefas.

No programa Manutenção Categoria Item (PD0623) é possível definir todas as famílias comercias (Categoria) e seus respectivos itens (Produtos) que serão enviados ao Ciashop. Importante ressaltar que os itens que serão enviados para o Ciashop precisam obrigatoriamente estarem cadastrados no programa Tabela Preço (CD1508), este cadastro é necessário pois o preço do produto no Ciashop, é o valor informado no campo Preço FOB do programa CD1508. Para que o saldo disponível em estoque do item, seja enviado ao Ciashop, é necessário que este possua saldo em estoque disponível, caso o item não possua saldo, é possível realizar o cadastro por meio do programa Transações Diversas Estoque (CE0220).

Para o envio das informações de saldo e preço do item, serão considerados o depósito e a tabela de preço padrão informados no programa Parâmetros Integração Ciashop (PD0310). Obrigatoriamente todos os itens enviados para o Ciashop, deverão estar cadastrados na tabela de preço informada no programa PD0310, assim como deverão estar cadastrados com saldo em estoque para o depósito informado no PD0310.

Cadastros 

A seguir o diagrama de fluxo de informações relacionando os cadastros integrados entre BackOffice Datasul e Ciashop. Após o diagrama serão descritos os detalhes da integração de cada cadastro.

Antes de enviar os cadastros de item, família comercial, saldo em estoque e preço item, é necessário ativar a integração por meio do programa Atualização Parâmetro Global (CD0101), aba Integr II, campo Ciashop:

Além disso é necessário realizar a parametrização da integração através do programa Parâmetros Integrações Ciashop (PD0310):

Segue detalhamento dos campos: 

• Estabelecimento: Informar o estabelecimento que será utilizado na integração.;

• Host: O host deverá ser solicitado a Ciashop.

• ;

• Porta Padrão: A porta deverá ser solicitada a Ciashop.;

• Token: O token deverá ser solicitado a Ciashop.;

• Grupo Cliente: O grupo cliente padrão será utilizado para a inclusão de clientes no ERP, durante a implantação do pedido oriundo do Ciashop no ERP Datasul. As informações que serão consideradas são: Natureza, Portador, Modalidade, Representante, Atividade, Tipo Receita/Despesa e Percentual de Desconto. Estas informações podem ser consultadas por meio do programa CD0701 (Manutenção Grupo Cliente);

• Natureza de operação: Informar neste campo a natureza de operação estadual que será utilizada durante a implantação do pedido de venda no ERP Datasul.

• ;

• Natureza de operação interestadual: Informar neste campo a natureza de operação interestadual que será utilizada durante a implantação do pedido de venda no ERP Datasul.;

• Tabela de Preço: Na primeira fase a integração não está tratando múltiplas tabelas de preço. A tabela de preço que for parametrizada no Ciashop, deverá ser a mesma informada neste campo.;

• Depósito: Na primeira fase a integração não está tratando múltiplos depósitos. Para consulta do saldo em estoque, será considerado apenas o depósito informado neste campo.

• ;

• Nr Último Pedido: Este campo será atualizado conforme a entrada de pedidos oriundos do Ciashop no ERP Datasul. Neste campo estará informado sempre o código do último pedido Ciashop que foi buscado pelo programa PD0624 (Integração Batch Ciashop).

FAMÍLIA COMERCIAL

Para que a integração do cadastro de Família Comercial seja realizada é obrigatório:

•     Integração Ciashop ativada no programa CD0101.
  
  

Além disso é necessário cadastrar esta família comercial no programa Manutenção Categoria Item (PD0623):

•     Ao cadastrar uma família comercial, todos os itens vinculados a esta família serão automaticamente apresentados em tela.

As famílias comerciais (no contexto Ciashop possuem a descrição de categorias),  enviadas do BackOffice Datasul para o Ciashop, poderão ser consultadas no manager do Ciashop, por meio do menu: Categorias e Produtos -> Gerenciar Categorias:

ITEM

Para que a integração do cadastro de itens seja realizada é obrigatório marcar o parâmetro "Item" no programa Integração Batch Ciashop (PD0624), aba parâmetro:

Image RemovedImage Added

Além disso é necessário definir que este item será considerado na integração com o Ciashop por meio do programa Manutenção Categoria Item (PD0623):

• A imagem acima é uma demonstração de que os itens TV-4k e TV-LED serão considerados na integração com o Ciashop.;
• Além disso, é necessário cadastrar os itens que serão enviados para o Ciashop na tabela de preço que foi informado no programa PD0310.

Os itens enviados do BackOffice Datasul para o Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos:

Image Removed

Preço/Tabela de Preço

Para que a integração da atualização do preço do item seja realizado é obrigatório:

Além disso é necessário cadastrar os preços para todos os itens que serão enviados para o Ciashop por meio do programa Tabela Preço (CD1508):

• ;

• É necessário informar para os itens que serão enviados ao Ciashop, o código EAN/GTIN por meio do campo Cód GTIN (TRIB), que está localizado no programa Atualização Itens Faturamento (CD0903), aba Fiscal;

• Para itens com referência, é necessário que seja informado no campo "tipo de referência" do programa Manutenção Referências Itens (CD1506) a identificação da referência. Por exemplo: Cor, Tamanho e etc...

Os itens enviados do BackOffice Datasul para o Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos:

Image Added

Preço/Tabela de Preço

Para que a integração da atualização do preço do item seja realizado é obrigatório:

•  Integração Ciashop ativada no programa CD0101;
  
•  A tabela de preço informada no programa PD0310 deve estar cadastrada no manager do Ciashop.
  
  

Além disso é necessário cadastrar os preços para todos os itens que serão enviados para o Ciashop por meio do programa Tabela Preço (CD1508):

•  O Preço do item que será considerado ao enviar o registro para o Ciashop, é o valor informado no campo Preço FOB do programa CD1508.
  
  

 Image Added

Os preços enviados do BackOffice Datasul para o Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos ->

 Image Removed

Os preços enviados do BackOffice Datasul para o Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos -> Cadastros de Produtos -> Preço e Estoque:

Saldo em Estoque

Para que a integração da atualização do saldo em estoque disponível dos itens seja realizado é obrigatório:

•  Integração Ciashop ativada no programa CD0101.   
  
  

O cadastro de saldo em estoque poderá ser realizado por meio do programa Transações Diversas Estoque (CE0220):

•  Os itens que serão integrados, deverão estar com saldo em estoque cadastrados para o depósito informado no programa PD0310.
  
  

O saldo em estoque enviado do BackOffice Datasul para o Ciashop, poderá ser consultado no manager do Ciashop, por meio do menu: Categorias e Produtos -> Catálogos de Produtos -> Cadastros de Produtos -> Preço e Estoque:

Através do programa Monitor Integração Ciashop (PD0625), é possível realizar a consulta do envio dos registros referente aos cadastros de Família Comercial, Itens, Preço Item,Saldo em Estoque, recepção dos pedidos e atualização dos status dos pedidos:

• Quando um registro for integrado com sucesso, a cor do grid ficará destacada em azul;
• Quando um registro não for integrado com sucesso, a cor do grid ficará destacada em vermelho;
• No grid Ocorrências Integração, é possível detalhar a mensagem com um clique duplo caso necessário.

Descreva características gerais Recepção 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>

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.

Pedido de Venda

Para que a recepção do pedido de venda seja realizada é obrigatório:

•  Integração Ciashop ativada no programa CD0101.  

A recepção do pedido de venda é realizado por meio do parâmetro "Pedido Venda" no programa Integração Batch Ciashop (PD0624), aba parâmetro:

• Através do programa PD0625 será possível verificar se o pedido foi importado com sucesso ou não, em caso de falha, será possível realizar a importação desse pedido novamente por meio do botão "Buscar Pedido", localizado no programa PD0625;
• No programa PD0310, existe o campo Nr Último Pedido, sempre que a recepção do pedido de venda for disparado, o pedido a ser solicitado ao Ciashop, sempre será o número do último pedido + 1, ou seja, caso no campo Nr último Pedido esteja armazenado o valor 20, será solicitado ao Ciashop todos os pedidos que possuírem o número de pedido superior ao 20;
• Para a recepção de novos pedidos utilizar o programa PD0624, e para pedidos que já foram importados do Ciashop mas que por algum motivo não foram incluídos com sucesso, utilizar o botão "Buscar Pedido" do programa PD0625.
  
   
  

Os pedidos disponíveis no Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Minhas Vendas -> Gerenciar Pedidos -> Listagem de Pedidos:

Image Added

Atualização da situação do Pedido de Venda

Para a atualização da situação do pedido de venda é obrigatório:

•  Integração Ciashop ativada no programa CD0101. 
  

A atualização da situação do pedido de venda é realizado por meio do parâmetro "Atualizar situação dos Pedidos " no programa Integração Batch Ciashop (PD0624), aba parâmetro:

• Através do programa PD0625 também  será possível atualizar a situação do pedido caso necessário por meio do botão "Atualizar Situação", localizado no programa PD0625;
• Na primeira carga da atualização da situação do pedido, será atualizada a situação de todos os pedidos que já foram importados no BackOffice Datasul, nas proximas atualizações será respeitado a data e o horário gravado nos campos Data e Horário do programa PD0624, aba Parâmetro. Ou seja, será solicitado ao Ciashop, somente os pedidos que foram incluídos ou sofreram atualizações após a data e horário apresentados no programa PD0624;
  
• Se por algum motivo, for necessário executar a atualização da situação do pedido com uma data inferior a que está sendo apresentado em tela, utilizar o parâmetro "Atualizar Situação dos Pedidos a partir de", preenchendo também a data e horário para a busca ser realizada com sucesso.
  

A situação dos pedidos disponíveis no Ciashop, poderão ser consultados no manager do Ciashop, por meio do menu: Minhas Vendas -> Gerenciar Pedidos -> Listagem de Pedidos. Ou através do programa Monitor de Integração Ciashop (PD0625) no BackOffice Datasul, coluna "Situação":

Image Added

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

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.

Processos

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).

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

• Para itens com referência, o código GTIN/EAN, será gravado somente para a primeira referência do item;
• Ao eliminar um registro no Ciashop, este registro não será eliminado automaticamente no BackOffice Datasul;
• Neste primeiro momento, não é possível trabalhar com múltiplos depósitos;
• Neste primeiro momento, não é possível trabalhar com múltiplas tabelas de preço;

• Caso o item possua algum caractere especial no nome, o caractere especial será retirado durante o envio para o Ciashop. No Ciashop o item será apresentado sem caracteres especiais;

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)

Tratamento de erros de integração (Produto B)

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